GET v1/Sites/{siteId}/Kiosks
Retrieves all the kiosks for a particular site
URI template
v1/Sites/{siteId}/KiosksRequest Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId |
The internal id of the site |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Kiosks. Known internal error is BadRequest and InternalServerError
Collection of KioskResultName | Description | Type | Additional information |
---|---|---|---|
KioskId |
Id used to identify the kiosk |
integer |
None. |
Description |
Description of the kiosk |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "KioskId": 1, "Description": "sample string 2" }, { "$id": "2", "KioskId": 3, "Description": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfKioskResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <KioskResult> <Description>sample string 2</Description> <KioskId>1</KioskId> </KioskResult> <KioskResult> <Description>sample string 4</Description> <KioskId>3</KioskId> </KioskResult> </ArrayOfKioskResult>