JiwaAPI

<back to all web services

SM_DebtorManagerQuery

Requires Authentication
SM_DebtorManagerQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
FNamequerystringNo
FNameStartsWithquerystringNo
FNameEndsWithquerystringNo
FNameContainsquerystringNo
FNameLikequerystringNo
FNameBetweenquerystring[]No
FNameInquerystring[]No
SNamequerystringNo
SNameStartsWithquerystringNo
SNameEndsWithquerystringNo
SNameContainsquerystringNo
SNameLikequerystringNo
SNameBetweenquerystring[]No
SNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SM_DebtorManager Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
NameformstringNo
StaffIDformstringNo
FNameformstringNo
SNameformstringNo
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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/SM_DebtorManagerQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"FName":"String","FNameStartsWith":"String","FNameEndsWith":"String","FNameContains":"String","FNameLike":"String","FNameBetween":["String"],"FNameIn":["String"],"SName":"String","SNameStartsWith":"String","SNameEndsWith":"String","SNameContains":"String","SNameLike":"String","SNameBetween":["String"],"SNameIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"DebtorID":"String","Name":"String","StaffID":"String","FName":"String","SName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}