JiwaAPI

<back to all web services

DebtorContactNamePOSTRequest

Requires Authentication
The following routes are available for this service:
POST/Debtors/{DebtorID}/ContactNamesAppends a contact name to a debtor.
DebtorContactNamePOSTRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
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
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Debtors/{DebtorID}/ContactNames HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DebtorID":"String","DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"ContactID":"String","AccountNo":"String","Title":"String","FirstName":"String","Surname":"String","PrimaryPositionID":"String","PrimaryPositionName":"String","SecondaryPositionID":"String","SecondaryPositionName":"String","TertiaryPositionID":"String","TertiaryPositionName":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","LogonCode":"String","LogonPassword":"String","ExternalAppRecID":"String","LogonCodeChangedByUser":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"ContactNameID":"String","ContactID":"String","AccountNo":"String","Title":"String","FirstName":"String","Surname":"String","PrimaryPositionID":"String","PrimaryPositionName":"String","SecondaryPositionID":"String","SecondaryPositionName":"String","TertiaryPositionID":"String","TertiaryPositionName":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","LogonCode":"String","LogonPassword":"String","ExternalAppRecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LogonCodeChangedByUser":false}