| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeliveryID | query | string | No | |
| DeliveryIDStartsWith | query | string | No | |
| DeliveryIDEndsWith | query | string | No | |
| DeliveryIDContains | query | string | No | |
| DeliveryIDLike | query | string | No | |
| DeliveryIDBetween | query | string[] | No | |
| DeliveryIDIn | query | string[] | No | |
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| Address1 | query | string | No | |
| Address1StartsWith | query | string | No | |
| Address1EndsWith | query | string | No | |
| Address1Contains | query | string | No | |
| Address1Like | query | string | No | |
| Address1Between | query | string[] | No | |
| Address1In | query | string[] | No | |
| Address2 | query | string | No | |
| Address2StartsWith | query | string | No | |
| Address2EndsWith | query | string | No | |
| Address2Contains | query | string | No | |
| Address2Like | query | string | No | |
| Address2Between | query | string[] | No | |
| Address2In | query | string[] | No | |
| Address3 | query | string | No | |
| Address3StartsWith | query | string | No | |
| Address3EndsWith | query | string | No | |
| Address3Contains | query | string | No | |
| Address3Like | query | string | No | |
| Address3Between | query | string[] | No | |
| Address3In | query | string[] | No | |
| Address4 | query | string | No | |
| Address4StartsWith | query | string | No | |
| Address4EndsWith | query | string | No | |
| Address4Contains | query | string | No | |
| Address4Like | query | string | No | |
| Address4Between | query | string[] | No | |
| Address4In | query | string[] | No | |
| PostCode | query | string | No | |
| PostCodeStartsWith | query | string | No | |
| PostCodeEndsWith | query | string | No | |
| PostCodeContains | query | string | No | |
| PostCodeLike | query | string | No | |
| PostCodeBetween | query | string[] | No | |
| PostCodeIn | query | string[] | No | |
| Notes | query | string | No | |
| NotesStartsWith | query | string | No | |
| NotesEndsWith | query | string | No | |
| NotesContains | query | string | No | |
| NotesLike | query | string | No | |
| NotesBetween | query | string[] | No | |
| NotesIn | query | string[] | No | |
| CourierDetails | query | string | No | |
| CourierDetailsStartsWith | query | string | No | |
| CourierDetailsEndsWith | query | string | No | |
| CourierDetailsContains | query | string | No | |
| CourierDetailsLike | query | string | No | |
| CourierDetailsBetween | query | string[] | No | |
| CourierDetailsIn | query | string[] | No | |
| DefaultItem | query | bool? | No | |
| LineNum | query | int? | No | |
| LineNumGreaterThanOrEqualTo | query | int? | No | |
| LineNumGreaterThan | query | int? | No | |
| LineNumLessThan | query | int? | No | |
| LineNumLessThanOrEqualTo | query | int? | No | |
| LineNumNotEqualTo | query | int? | No | |
| LineNumBetween | query | Nullable<Int32>[] | No | |
| LineNumIn | query | Nullable<Int32>[] | No | |
| EDIStoreLocationCode | query | string | No | |
| EDIStoreLocationCodeStartsWith | query | string | No | |
| EDIStoreLocationCodeEndsWith | query | string | No | |
| EDIStoreLocationCodeContains | query | string | No | |
| EDIStoreLocationCodeLike | query | string | No | |
| EDIStoreLocationCodeBetween | query | string[] | No | |
| EDIStoreLocationCodeIn | query | string[] | No | |
| DeliveryAddressCode | query | string | No | |
| DeliveryAddressCodeStartsWith | query | string | No | |
| DeliveryAddressCodeEndsWith | query | string | No | |
| DeliveryAddressCodeContains | query | string | No | |
| DeliveryAddressCodeLike | query | string | No | |
| DeliveryAddressCodeBetween | query | string[] | No | |
| DeliveryAddressCodeIn | query | string[] | No | |
| DeliveryAddressName | query | string | No | |
| DeliveryAddressNameStartsWith | query | string | No | |
| DeliveryAddressNameEndsWith | query | string | No | |
| DeliveryAddressNameContains | query | string | No | |
| DeliveryAddressNameLike | query | string | No | |
| DeliveryAddressNameBetween | query | string[] | No | |
| DeliveryAddressNameIn | query | string[] | No | |
| Country | query | string | No | |
| CountryStartsWith | query | string | No | |
| CountryEndsWith | query | string | No | |
| CountryContains | query | string | No | |
| CountryLike | query | string | No | |
| CountryBetween | query | string[] | No | |
| CountryIn | query | string[] | 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 |
|---|---|---|---|---|
| DeliveryID | form | string | No | |
| DebtorID | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| Address4 | form | string | No | |
| PostCode | form | string | No | |
| Notes | form | string | No | |
| CourierDetails | form | string | No | |
| DefaultItem | form | bool? | No | |
| LineNum | form | int? | No | |
| EDIStoreLocationCode | form | string | No | |
| DeliveryAddressCode | form | string | No | |
| DeliveryAddressName | form | string | No | |
| Country | form | string | 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_DeliveryAddressQuery HTTP/1.1
Host: localhost
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"}}}