JiwaAPI

<back to all web services

RESTAPICustomRoutesPlugin.DebtorContactQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/DebtorContactRetrieves a list of debtor contacts.
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

GET /Queries/DebtorContact HTTP/1.1 
Host: localhost 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"ContactID":"String","DebtorID":"String","AccountNo":"String","Title":"String","FName":"String","SName":"String","PrimaryID":"String","PrimaryPositionName":"String","SecondaryID":"String","TertiaryID":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","DefaultContact":false,"CreditorContact":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}