JiwaAPI

<back to all web services

DB_EDIMainQuery

Requires Authentication
DB_EDIMainQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
EDIEnabledquerybool?No
EDIAddressquerystringNo
EDIAddressStartsWithquerystringNo
EDIAddressEndsWithquerystringNo
EDIAddressContainsquerystringNo
EDIAddressLikequerystringNo
EDIAddressBetweenquerystring[]No
EDIAddressInquerystring[]No
EDIOrderTypequerybyte?No
EDIOrderTypeGreaterThanOrEqualToquerybyte?No
EDIOrderTypeGreaterThanquerybyte?No
EDIOrderTypeLessThanquerybyte?No
EDIOrderTypeLessThanOrEqualToquerybyte?No
EDIOrderTypeNotEqualToquerybyte?No
EDIOrderTypeBetweenqueryNullable<Byte>[]No
EDIOrderTypeInqueryNullable<Byte>[]No
EDIPricesIncludeTaxquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_EDIMain Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
EDIEnabledformbool?No
EDIAddressformstringNo
EDIOrderTypeformbyte?No
EDIPricesIncludeTaxformbool?No
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.

POST /json/reply/DB_EDIMainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"EDIEnabled":false,"EDIAddress":"String","EDIAddressStartsWith":"String","EDIAddressEndsWith":"String","EDIAddressContains":"String","EDIAddressLike":"String","EDIAddressBetween":["String"],"EDIAddressIn":["String"],"EDIOrderType":0,"EDIOrderTypeGreaterThanOrEqualTo":0,"EDIOrderTypeGreaterThan":0,"EDIOrderTypeLessThan":0,"EDIOrderTypeLessThanOrEqualTo":0,"EDIOrderTypeNotEqualTo":0,"EDIOrderTypeBetween":[0],"EDIOrderTypeIn":[0],"EDIPricesIncludeTax":false,"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"DebtorID":"String","EDIEnabled":false,"EDIAddress":"String","EDIOrderType":0,"EDIPricesIncludeTax":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}