GET v1/Instructions
Retrieves Instructions for a site and an order mode
URI template
v1/Instructions?siteId={siteId}&destinationType={destinationType}&offset={offset}&limit={limit}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId |
The internal id of the site |
integer |
Required |
destinationType |
The destination type you want instructions for |
DestinationType |
Required |
offset |
used for paging, will return the results from the overall result set after this number |
integer |
Default value is 0 |
limit |
limits the number of results returned |
integer |
Default value is 5 |
Body Parameters
None.
Response Information
Resource Description
Known internal errors are BadRequest, ValueNotFound, InvalidParameters
Collection of MobileSiteInstructionName | Description | Type | Additional information |
---|---|---|---|
SiteId |
SiteId of the instruction. Note: Will be zero for Company wide settings |
integer |
None. |
InstructionId |
Get or set the InstructionId property |
integer |
None. |
DestinationType |
Get or set the DestinationType property |
DestinationType |
None. |
ImageUrl |
Get or set the Image Url property |
string |
None. |
Text |
Get or set the Text property |
string |
None. |
SequenceNumber |
Get or set the sequenceNumber property |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "SiteId": 1, "InstructionId": 2, "DestinationType": 0, "ImageUrl": "sample string 3", "Text": "sample string 4", "SequenceNumber": 5 }, { "$id": "2", "SiteId": 6, "InstructionId": 7, "DestinationType": 0, "ImageUrl": "sample string 8", "Text": "sample string 9", "SequenceNumber": 10 } ]
application/xml, text/xml
Sample:
<ArrayOfMobileSiteInstruction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <MobileSiteInstruction> <DestinationType>DestinationNull</DestinationType> <ImageUrl>sample string 3</ImageUrl> <InstructionId>2</InstructionId> <SequenceNumber>5</SequenceNumber> <SiteId>1</SiteId> <Text>sample string 4</Text> </MobileSiteInstruction> <MobileSiteInstruction> <DestinationType>DestinationNull</DestinationType> <ImageUrl>sample string 8</ImageUrl> <InstructionId>7</InstructionId> <SequenceNumber>10</SequenceNumber> <SiteId>6</SiteId> <Text>sample string 9</Text> </MobileSiteInstruction> </ArrayOfMobileSiteInstruction>