All Verbs | /service/QueryRetailLocations | ||
---|---|---|---|
All Verbs | /service/QueryRetailLocations/{ZipCode} | ||
All Verbs | /service/QueryRetailLocations/{ZipCode}/{Distance} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ZipCode | path | string | No | |
ProductId | query | string | No | |
Radius | query | double | No | |
Distance | path | double | 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 |
---|---|---|---|---|
RetailerId | form | string | No | |
Latitude | form | double | No | |
Longitude | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
PersonName | form | PersonNameInfo | No | |
Address | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
StoreSize | form | string | No | |
Custom2 | form | string | No | |
AccountType | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Salutation | form | string | No | |
First | form | string | No | |
Middle | form | string | No | |
Last | form | string | No | |
Suffix | form | string | No | |
Full | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryRetailLocations HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"zipCode":"String","productId":"String","radius":0,"distance":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 {"offset":0,"total":0,"results":[{"retailerId":"String","latitude":0,"longitude":0,"id":"String","companyName":"String","personName":{"salutation":"String","first":"String","middle":"String","last":"String","suffix":"String","full":"String String String String String"},"address":"String","address1":"String","address2":"String","city":"String","state":"String","zip":"String","country":"String","phone":"String","fax":"String","email":"String","storeSize":"String","custom2":"String","accountType":"String","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}