GET v1/CurbsideZones/{siteId}
Returns a list of the curb zones for the given site
URI template
v1/CurbsideZones/{siteId}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId |
The site where you are trying to get available curbsidezones for |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a list of CurbsideZones. Known Internal errors are InvalidParameters and BadRequest.
Collection of CurbSideZoneName | Description | Type | Additional information |
---|---|---|---|
SiteId |
The Aloha Online Site Id |
integer |
None. |
ZoneName |
The name of the zone |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "SiteId": 1, "ZoneName": "sample string 2" }, { "$id": "2", "SiteId": 3, "ZoneName": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfCurbSideZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <CurbSideZone> <SiteId>1</SiteId> <ZoneName>sample string 2</ZoneName> </CurbSideZone> <CurbSideZone> <SiteId>3</SiteId> <ZoneName>sample string 4</ZoneName> </CurbSideZone> </ArrayOfCurbSideZone>