JiwaAPI

<back to all web services

DB_DirectorsQuery

Requires Authentication
DB_DirectorsQuery Parameters:
NameParameterData TypeRequiredDescription
DirectorIDquerystringNo
DirectorIDStartsWithquerystringNo
DirectorIDEndsWithquerystringNo
DirectorIDContainsquerystringNo
DirectorIDLikequerystringNo
DirectorIDBetweenquerystring[]No
DirectorIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DirectorNamequerystringNo
DirectorNameStartsWithquerystringNo
DirectorNameEndsWithquerystringNo
DirectorNameContainsquerystringNo
DirectorNameLikequerystringNo
DirectorNameBetweenquerystring[]No
DirectorNameInquerystring[]No
AddressquerystringNo
AddressStartsWithquerystringNo
AddressEndsWithquerystringNo
AddressContainsquerystringNo
AddressLikequerystringNo
AddressBetweenquerystring[]No
AddressInquerystring[]No
OfficeHeldquerystringNo
OfficeHeldStartsWithquerystringNo
OfficeHeldEndsWithquerystringNo
OfficeHeldContainsquerystringNo
OfficeHeldLikequerystringNo
OfficeHeldBetweenquerystring[]No
OfficeHeldInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_Directors Parameters:
NameParameterData TypeRequiredDescription
DirectorIDformstringNo
DebtorIDformstringNo
DirectorNameformstringNo
AddressformstringNo
OfficeHeldformstringNo
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/DB_DirectorsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DirectorID":"String","DirectorIDStartsWith":"String","DirectorIDEndsWith":"String","DirectorIDContains":"String","DirectorIDLike":"String","DirectorIDBetween":["String"],"DirectorIDIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DirectorName":"String","DirectorNameStartsWith":"String","DirectorNameEndsWith":"String","DirectorNameContains":"String","DirectorNameLike":"String","DirectorNameBetween":["String"],"DirectorNameIn":["String"],"Address":"String","AddressStartsWith":"String","AddressEndsWith":"String","AddressContains":"String","AddressLike":"String","AddressBetween":["String"],"AddressIn":["String"],"OfficeHeld":"String","OfficeHeldStartsWith":"String","OfficeHeldEndsWith":"String","OfficeHeldContains":"String","OfficeHeldLike":"String","OfficeHeldBetween":["String"],"OfficeHeldIn":["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":[{"DirectorID":"String","DebtorID":"String","DirectorName":"String","Address":"String","OfficeHeld":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}