POST API/V40/Interactive/Outlet/{outletCode}/deliveryLocation/{deliveryLocationCode}/CallWaiter

Place call waiter request

Request Information

URI Parameters

Name	Description	Type	Additional information
outletCode	The outlet code for the outlet we send call waiter against.	string	Required
deliveryLocationCode	The delivery location	string	Required

Body Parameters

The request model

OutletCallWaiterRequest

Name	Description	Type	Additional information
Comment	If associated with a Pos system, then this comment will be sent.	string
NumberOfGuests		integer
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "comment": "sample string 1",
  "numberOfGuests": 2,
  "sessionToken": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "Pm9duJwP3YgKAAAAAAAAAAAAAAA.lHf-Cg53vcQsVkPOXod85nk_4rJYljFRFQCSbVV4bTc",
  "responsesIncluded": "responseStatus",
  "responses": [
    {
      "responseStatus": {
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}