JiwaAPI

<back to all web services

MyDebtorContactGetRequest

Requires Authentication
The following routes are available for this service:
GET/Debtors/{DebtorID}/MyContactsRetrieves a list of contacts for a debtor.
MyDebtorContactGetRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
MyDebtorContactGetResponse Parameters:
NameParameterData TypeRequiredDescription
ContactsformList<CN_Contact>No
CN_Contact Parameters:
NameParameterData TypeRequiredDescription
ContactIDformstringNo
AccNoformstringNo
TitleformstringNo
FNameformstringNo
SNameformstringNo
PrimaryIDformstringNo
SecondaryIDformstringNo
TertiaryIDformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
EmailAddressformstringNo
ProspectIDformstringNo
LogonCodeformstringNo
LogonPasswordformstringNo
ExternalAppRecIDformstringNo
DefaultContactformbool?No
DebtorContactformbool?No
CreditorContactformbool?No
LastSavedDateTimeformDateTime?No
ItemNoformintNo

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}/MyContacts HTTP/1.1 
Host: apitrain.galipo.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MyDebtorContactGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_Contacts_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:CN_Contact>
      <d2p1:_x003C_AccNo_x003E_k__BackingField>String</d2p1:_x003C_AccNo_x003E_k__BackingField>
      <d2p1:_x003C_ContactID_x003E_k__BackingField>String</d2p1:_x003C_ContactID_x003E_k__BackingField>
      <d2p1:_x003C_CreditorContact_x003E_k__BackingField>false</d2p1:_x003C_CreditorContact_x003E_k__BackingField>
      <d2p1:_x003C_DebtorContact_x003E_k__BackingField>false</d2p1:_x003C_DebtorContact_x003E_k__BackingField>
      <d2p1:_x003C_DefaultContact_x003E_k__BackingField>false</d2p1:_x003C_DefaultContact_x003E_k__BackingField>
      <d2p1:_x003C_EmailAddress_x003E_k__BackingField>String</d2p1:_x003C_EmailAddress_x003E_k__BackingField>
      <d2p1:_x003C_ExternalAppRecID_x003E_k__BackingField>String</d2p1:_x003C_ExternalAppRecID_x003E_k__BackingField>
      <d2p1:_x003C_FName_x003E_k__BackingField>String</d2p1:_x003C_FName_x003E_k__BackingField>
      <d2p1:_x003C_Fax_x003E_k__BackingField>String</d2p1:_x003C_Fax_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LogonCode_x003E_k__BackingField>String</d2p1:_x003C_LogonCode_x003E_k__BackingField>
      <d2p1:_x003C_LogonPassword_x003E_k__BackingField>String</d2p1:_x003C_LogonPassword_x003E_k__BackingField>
      <d2p1:_x003C_Mobile_x003E_k__BackingField>String</d2p1:_x003C_Mobile_x003E_k__BackingField>
      <d2p1:_x003C_Phone_x003E_k__BackingField>String</d2p1:_x003C_Phone_x003E_k__BackingField>
      <d2p1:_x003C_PrimaryID_x003E_k__BackingField>String</d2p1:_x003C_PrimaryID_x003E_k__BackingField>
      <d2p1:_x003C_ProspectID_x003E_k__BackingField>String</d2p1:_x003C_ProspectID_x003E_k__BackingField>
      <d2p1:_x003C_SName_x003E_k__BackingField>String</d2p1:_x003C_SName_x003E_k__BackingField>
      <d2p1:_x003C_SecondaryID_x003E_k__BackingField>String</d2p1:_x003C_SecondaryID_x003E_k__BackingField>
      <d2p1:_x003C_TertiaryID_x003E_k__BackingField>String</d2p1:_x003C_TertiaryID_x003E_k__BackingField>
      <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    </d2p1:CN_Contact>
  </_x003C_Contacts_x003E_k__BackingField>
</MyDebtorContactGetResponse>