JiwaAPI

<back to all web services

DB_DeliveryAddress_DeliveryAreaSelectionQuery

Requires Authentication
DB_DeliveryAddress_DeliveryAreaSelectionQuery Parameters:
NameParameterData TypeRequiredDescription
DB_DeliveryAddress_DeliveryIDquerystringNo
DB_DeliveryAddress_DeliveryIDStartsWithquerystringNo
DB_DeliveryAddress_DeliveryIDEndsWithquerystringNo
DB_DeliveryAddress_DeliveryIDContainsquerystringNo
DB_DeliveryAddress_DeliveryIDLikequerystringNo
DB_DeliveryAddress_DeliveryIDBetweenquerystring[]No
DB_DeliveryAddress_DeliveryIDInquerystring[]No
UseSpecificDeliveryAreaquerybool?No
DeliveryArea_RecIDqueryGuid?No
DeliveryArea_RecIDInqueryNullable<Guid>[]No
DefaultTimeAtStopqueryint?No
DefaultTimeAtStopGreaterThanOrEqualToqueryint?No
DefaultTimeAtStopGreaterThanqueryint?No
DefaultTimeAtStopLessThanqueryint?No
DefaultTimeAtStopLessThanOrEqualToqueryint?No
DefaultTimeAtStopNotEqualToqueryint?No
DefaultTimeAtStopBetweenqueryNullable<Int32>[]No
DefaultTimeAtStopInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_DeliveryAddress_DeliveryAreaSelection Parameters:
NameParameterData TypeRequiredDescription
DB_DeliveryAddress_DeliveryIDformstringNo
UseSpecificDeliveryAreaformboolNo
DeliveryArea_RecIDformGuid?No
DefaultTimeAtStopformint?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_DeliveryAddress_DeliveryAreaSelectionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DB_DeliveryAddress_DeliveryID":"String","DB_DeliveryAddress_DeliveryIDStartsWith":"String","DB_DeliveryAddress_DeliveryIDEndsWith":"String","DB_DeliveryAddress_DeliveryIDContains":"String","DB_DeliveryAddress_DeliveryIDLike":"String","DB_DeliveryAddress_DeliveryIDBetween":["String"],"DB_DeliveryAddress_DeliveryIDIn":["String"],"UseSpecificDeliveryArea":false,"DeliveryArea_RecID":"00000000000000000000000000000000","DeliveryArea_RecIDIn":["00000000000000000000000000000000"],"DefaultTimeAtStop":0,"DefaultTimeAtStopGreaterThanOrEqualTo":0,"DefaultTimeAtStopGreaterThan":0,"DefaultTimeAtStopLessThan":0,"DefaultTimeAtStopLessThanOrEqualTo":0,"DefaultTimeAtStopNotEqualTo":0,"DefaultTimeAtStopBetween":[0],"DefaultTimeAtStopIn":[0],"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":[{"DB_DeliveryAddress_DeliveryID":"String","DeliveryArea_RecID":"00000000000000000000000000000000","DefaultTimeAtStop":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}