JiwaAPI

<back to all web services

DB_DeliveryAddressQuery

Requires Authentication
DB_DeliveryAddressQuery Parameters:
NameParameterData TypeRequiredDescription
DeliveryIDquerystringNo
DeliveryIDStartsWithquerystringNo
DeliveryIDEndsWithquerystringNo
DeliveryIDContainsquerystringNo
DeliveryIDLikequerystringNo
DeliveryIDBetweenquerystring[]No
DeliveryIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
Address1querystringNo
Address1StartsWithquerystringNo
Address1EndsWithquerystringNo
Address1ContainsquerystringNo
Address1LikequerystringNo
Address1Betweenquerystring[]No
Address1Inquerystring[]No
Address2querystringNo
Address2StartsWithquerystringNo
Address2EndsWithquerystringNo
Address2ContainsquerystringNo
Address2LikequerystringNo
Address2Betweenquerystring[]No
Address2Inquerystring[]No
Address3querystringNo
Address3StartsWithquerystringNo
Address3EndsWithquerystringNo
Address3ContainsquerystringNo
Address3LikequerystringNo
Address3Betweenquerystring[]No
Address3Inquerystring[]No
Address4querystringNo
Address4StartsWithquerystringNo
Address4EndsWithquerystringNo
Address4ContainsquerystringNo
Address4LikequerystringNo
Address4Betweenquerystring[]No
Address4Inquerystring[]No
PostCodequerystringNo
PostCodeStartsWithquerystringNo
PostCodeEndsWithquerystringNo
PostCodeContainsquerystringNo
PostCodeLikequerystringNo
PostCodeBetweenquerystring[]No
PostCodeInquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
CourierDetailsquerystringNo
CourierDetailsStartsWithquerystringNo
CourierDetailsEndsWithquerystringNo
CourierDetailsContainsquerystringNo
CourierDetailsLikequerystringNo
CourierDetailsBetweenquerystring[]No
CourierDetailsInquerystring[]No
DefaultItemquerybool?No
LineNumqueryint?No
LineNumGreaterThanOrEqualToqueryint?No
LineNumGreaterThanqueryint?No
LineNumLessThanqueryint?No
LineNumLessThanOrEqualToqueryint?No
LineNumNotEqualToqueryint?No
LineNumBetweenqueryNullable<Int32>[]No
LineNumInqueryNullable<Int32>[]No
EDIStoreLocationCodequerystringNo
EDIStoreLocationCodeStartsWithquerystringNo
EDIStoreLocationCodeEndsWithquerystringNo
EDIStoreLocationCodeContainsquerystringNo
EDIStoreLocationCodeLikequerystringNo
EDIStoreLocationCodeBetweenquerystring[]No
EDIStoreLocationCodeInquerystring[]No
DeliveryAddressCodequerystringNo
DeliveryAddressCodeStartsWithquerystringNo
DeliveryAddressCodeEndsWithquerystringNo
DeliveryAddressCodeContainsquerystringNo
DeliveryAddressCodeLikequerystringNo
DeliveryAddressCodeBetweenquerystring[]No
DeliveryAddressCodeInquerystring[]No
DeliveryAddressNamequerystringNo
DeliveryAddressNameStartsWithquerystringNo
DeliveryAddressNameEndsWithquerystringNo
DeliveryAddressNameContainsquerystringNo
DeliveryAddressNameLikequerystringNo
DeliveryAddressNameBetweenquerystring[]No
DeliveryAddressNameInquerystring[]No
CountryquerystringNo
CountryStartsWithquerystringNo
CountryEndsWithquerystringNo
CountryContainsquerystringNo
CountryLikequerystringNo
CountryBetweenquerystring[]No
CountryInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_DeliveryAddress Parameters:
NameParameterData TypeRequiredDescription
DeliveryIDformstringNo
DebtorIDformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostCodeformstringNo
NotesformstringNo
CourierDetailsformstringNo
DefaultItemformbool?No
LineNumformint?No
EDIStoreLocationCodeformstringNo
DeliveryAddressCodeformstringNo
DeliveryAddressNameformstringNo
CountryformstringNo
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_DeliveryAddressQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DeliveryID":"String","DeliveryIDStartsWith":"String","DeliveryIDEndsWith":"String","DeliveryIDContains":"String","DeliveryIDLike":"String","DeliveryIDBetween":["String"],"DeliveryIDIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"Address1":"String","Address1StartsWith":"String","Address1EndsWith":"String","Address1Contains":"String","Address1Like":"String","Address1Between":["String"],"Address1In":["String"],"Address2":"String","Address2StartsWith":"String","Address2EndsWith":"String","Address2Contains":"String","Address2Like":"String","Address2Between":["String"],"Address2In":["String"],"Address3":"String","Address3StartsWith":"String","Address3EndsWith":"String","Address3Contains":"String","Address3Like":"String","Address3Between":["String"],"Address3In":["String"],"Address4":"String","Address4StartsWith":"String","Address4EndsWith":"String","Address4Contains":"String","Address4Like":"String","Address4Between":["String"],"Address4In":["String"],"PostCode":"String","PostCodeStartsWith":"String","PostCodeEndsWith":"String","PostCodeContains":"String","PostCodeLike":"String","PostCodeBetween":["String"],"PostCodeIn":["String"],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["String"],"CourierDetails":"String","CourierDetailsStartsWith":"String","CourierDetailsEndsWith":"String","CourierDetailsContains":"String","CourierDetailsLike":"String","CourierDetailsBetween":["String"],"CourierDetailsIn":["String"],"DefaultItem":false,"LineNum":0,"LineNumGreaterThanOrEqualTo":0,"LineNumGreaterThan":0,"LineNumLessThan":0,"LineNumLessThanOrEqualTo":0,"LineNumNotEqualTo":0,"LineNumBetween":[0],"LineNumIn":[0],"EDIStoreLocationCode":"String","EDIStoreLocationCodeStartsWith":"String","EDIStoreLocationCodeEndsWith":"String","EDIStoreLocationCodeContains":"String","EDIStoreLocationCodeLike":"String","EDIStoreLocationCodeBetween":["String"],"EDIStoreLocationCodeIn":["String"],"DeliveryAddressCode":"String","DeliveryAddressCodeStartsWith":"String","DeliveryAddressCodeEndsWith":"String","DeliveryAddressCodeContains":"String","DeliveryAddressCodeLike":"String","DeliveryAddressCodeBetween":["String"],"DeliveryAddressCodeIn":["String"],"DeliveryAddressName":"String","DeliveryAddressNameStartsWith":"String","DeliveryAddressNameEndsWith":"String","DeliveryAddressNameContains":"String","DeliveryAddressNameLike":"String","DeliveryAddressNameBetween":["String"],"DeliveryAddressNameIn":["String"],"Country":"String","CountryStartsWith":"String","CountryEndsWith":"String","CountryContains":"String","CountryLike":"String","CountryBetween":["String"],"CountryIn":["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":[{"DeliveryID":"String","DebtorID":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Notes":"String","CourierDetails":"String","DefaultItem":false,"LineNum":0,"EDIStoreLocationCode":"String","DeliveryAddressCode":"String","DeliveryAddressName":"String","Country":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}