JiwaAPI

<back to all web services

RESTAPICustomRoutesPlugin.DebtorContactGETRequest

Requires Authentication
The following routes are available for this service:
GET/Debtors/{DebtorID}/Contacts/{ContactID}Retrieve a debtor contact.
DebtorContact Parameters:
NameParameterData TypeRequiredDescription
ContactIDformstringNo
DebtorIDformstringNo
AccountNoformstringNo
TitleformstringNo
FNameformstringNo
SNameformstringNo
PrimaryIDformstringNo
PrimaryPositionNameformstringNo
SecondaryIDformstringNo
TertiaryIDformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
EmailAddressformstringNo
ProspectIDformstringNo
DefaultContactformbool?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}/Contacts/{ContactID} HTTP/1.1 
Host: localhost 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtorContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StottHoare.Jiwa.CustomRoutes">
  <AccountNo>String</AccountNo>
  <ContactID>String</ContactID>
  <CreditorContact>false</CreditorContact>
  <DebtorID>String</DebtorID>
  <DefaultContact>false</DefaultContact>
  <EmailAddress>String</EmailAddress>
  <FName>String</FName>
  <Fax>String</Fax>
  <ItemNo>0</ItemNo>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <Mobile>String</Mobile>
  <Phone>String</Phone>
  <PrimaryID>String</PrimaryID>
  <PrimaryPositionName>String</PrimaryPositionName>
  <ProspectID>String</ProspectID>
  <SName>String</SName>
  <SecondaryID>String</SecondaryID>
  <TertiaryID>String</TertiaryID>
  <Title>String</Title>
</DebtorContact>