PUT API/V40/Interactive/ServiceRequests

Create service request

Request Information

URI Parameters

None.

Body Parameters

The command parameters.

Name	Description	Type	Additional information
DeliveryDateTime	The requested delivery date time	date
IsDeliveryDateTimeUtc	Immediate requests can only pass UTC time, as we don't know 100% where the request is coming from Requests for later can only pass local time - we do not ecpect clients to make the conversion to UTC	boolean
Options	Service request options are now called modifiers in GXP v4	Collection of ServiceRequestOption
CategoryItemCode	The code of the category this service item belongs to	string	Required
Pin	Not yet implemeted - validates against the guests's chosen pin number	string
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:

{
  "deliveryDateTime": "2024-11-06T08:36:55.7959492+00:00",
  "isDeliveryDateTimeUtc": true,
  "options": [
    {
      "optionCode": "sample string 1",
      "value": "sample string 2"
    },
    {
      "optionCode": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "categoryItemCode": "sample string 2",
  "pin": "sample string 3",
  "sessionToken": "sample string 4"
}

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 ResponseStatus
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "nYPsKz7-3IgKAAAAAAAAAAAAAAA.8zaTLK78UAPXur6K2pHq3ZdmVHKhQ8tkkANvcAQS6qU",
  "responsesIncluded": "responseStatus",
  "responses": [
    {
      "responseStatus": {
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}