All Verbs | /service/QueryRetailersSearch |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | 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 |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
RepName | form | string | No | |
Status | form | string | No | |
PORequired | form | bool | No | |
IsCreditHold | form | bool | No | |
IsNewAccount | form | bool | No | |
PaymentTermsId | form | string | No | |
ShipMethodId | form | string | No | |
DefaultShipOn | form | DateTime? | No | |
ShippingPayment | form | string | No | |
PriceList | form | string | No | |
form | string | No | ||
Discount | form | decimal | No | |
Notes | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | 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 /service/QueryRetailersSearch HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"search":"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 {"offset":0,"total":0,"results":[{"id":"String","companyName":"String","address":"String","city":"String","state":"String","zip":"String","country":"String","phone":"String","repName":"String","status":"String","poRequired":false,"isCreditHold":false,"isNewAccount":false,"paymentTermsId":"String","shipMethodId":"String","defaultShipOn":"0001-01-01T00:00:00.0000000Z","shippingPayment":"String","priceList":"String","email":"String","discount":0,"notes":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}