| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DB_DeliveryAddress_DeliveryID | query | string | No | |
| DB_DeliveryAddress_DeliveryIDStartsWith | query | string | No | |
| DB_DeliveryAddress_DeliveryIDEndsWith | query | string | No | |
| DB_DeliveryAddress_DeliveryIDContains | query | string | No | |
| DB_DeliveryAddress_DeliveryIDLike | query | string | No | |
| DB_DeliveryAddress_DeliveryIDBetween | query | string[] | No | |
| DB_DeliveryAddress_DeliveryIDIn | query | string[] | No | |
| UseSpecificDeliveryArea | query | bool? | No | |
| DeliveryArea_RecID | query | Guid? | No | |
| DeliveryArea_RecIDIn | query | Nullable<Guid>[] | No | |
| DefaultTimeAtStop | query | int? | No | |
| DefaultTimeAtStopGreaterThanOrEqualTo | query | int? | No | |
| DefaultTimeAtStopGreaterThan | query | int? | No | |
| DefaultTimeAtStopLessThan | query | int? | No | |
| DefaultTimeAtStopLessThanOrEqualTo | query | int? | No | |
| DefaultTimeAtStopNotEqualTo | query | int? | No | |
| DefaultTimeAtStopBetween | query | Nullable<Int32>[] | No | |
| DefaultTimeAtStopIn | query | Nullable<Int32>[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DB_DeliveryAddress_DeliveryID | form | string | No | |
| UseSpecificDeliveryArea | form | bool | No | |
| DeliveryArea_RecID | form | Guid? | No | |
| DefaultTimeAtStop | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/DB_DeliveryAddress_DeliveryAreaSelectionQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
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: text/csv
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"}}}