JiwaAPI

<back to all web services

DebtorContactNameGETRequest

Requires Authentication
The following routes are available for this service:
GET/Debtors/{DebtorID}/ContactNames/{ContactNameID}Retrieves a debtor contact name.
DebtorContactNameGETRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
ContactNameIDpathstringNo
DebtorContactName Parameters:
NameParameterData TypeRequiredDescription
DefaultContactformbool?No
DebtorContactformbool?No
CreditorContactformbool?No
ContactNameIDformstringNo
ContactIDformstringNo
AccountNoformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
PrimaryPositionIDformstringNo
PrimaryPositionNameformstringNo
SecondaryPositionIDformstringNo
SecondaryPositionNameformstringNo
TertiaryPositionIDformstringNo
TertiaryPositionNameformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
EmailAddressformstringNo
ProspectIDformstringNo
LogonCodeformstringNo
LogonPasswordformstringNo
ExternalAppRecIDformstringNo
LastSavedDateTimeformDateTime?No
LogonCodeChangedByUserformbool?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Debtors/{DebtorID}/ContactNames/{ContactNameID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtorContactName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Debtors">
  <_x003C_AccountNo_x003E_k__BackingField>String</_x003C_AccountNo_x003E_k__BackingField>
  <_x003C_ContactID_x003E_k__BackingField>String</_x003C_ContactID_x003E_k__BackingField>
  <_x003C_ContactNameID_x003E_k__BackingField>String</_x003C_ContactNameID_x003E_k__BackingField>
  <_x003C_CreditorContact_x003E_k__BackingField>false</_x003C_CreditorContact_x003E_k__BackingField>
  <_x003C_DebtorContact_x003E_k__BackingField>false</_x003C_DebtorContact_x003E_k__BackingField>
  <_x003C_DefaultContact_x003E_k__BackingField>false</_x003C_DefaultContact_x003E_k__BackingField>
  <_x003C_EmailAddress_x003E_k__BackingField>String</_x003C_EmailAddress_x003E_k__BackingField>
  <_x003C_ExternalAppRecID_x003E_k__BackingField>String</_x003C_ExternalAppRecID_x003E_k__BackingField>
  <_x003C_Fax_x003E_k__BackingField>String</_x003C_Fax_x003E_k__BackingField>
  <_x003C_FirstName_x003E_k__BackingField>String</_x003C_FirstName_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_LogonCodeChangedByUser_x003E_k__BackingField>false</_x003C_LogonCodeChangedByUser_x003E_k__BackingField>
  <_x003C_LogonCode_x003E_k__BackingField>String</_x003C_LogonCode_x003E_k__BackingField>
  <_x003C_LogonPassword_x003E_k__BackingField>String</_x003C_LogonPassword_x003E_k__BackingField>
  <_x003C_Mobile_x003E_k__BackingField>String</_x003C_Mobile_x003E_k__BackingField>
  <_x003C_Phone_x003E_k__BackingField>String</_x003C_Phone_x003E_k__BackingField>
  <_x003C_PrimaryPositionID_x003E_k__BackingField>String</_x003C_PrimaryPositionID_x003E_k__BackingField>
  <_x003C_PrimaryPositionName_x003E_k__BackingField>String</_x003C_PrimaryPositionName_x003E_k__BackingField>
  <_x003C_ProspectID_x003E_k__BackingField>String</_x003C_ProspectID_x003E_k__BackingField>
  <_x003C_SecondaryPositionID_x003E_k__BackingField>String</_x003C_SecondaryPositionID_x003E_k__BackingField>
  <_x003C_SecondaryPositionName_x003E_k__BackingField>String</_x003C_SecondaryPositionName_x003E_k__BackingField>
  <_x003C_Surname_x003E_k__BackingField>String</_x003C_Surname_x003E_k__BackingField>
  <_x003C_TertiaryPositionID_x003E_k__BackingField>String</_x003C_TertiaryPositionID_x003E_k__BackingField>
  <_x003C_TertiaryPositionName_x003E_k__BackingField>String</_x003C_TertiaryPositionName_x003E_k__BackingField>
  <_x003C_Title_x003E_k__BackingField>String</_x003C_Title_x003E_k__BackingField>
</DebtorContactName>