POST API/V40/System/Session/InitialiseByToken

Initialise session by token

Request Information

URI Parameters

None.

Body Parameters

The command parameters.

Name	Description	Type	Additional information
PropertyCode	The code of the property (hotel etc.).	string	Required
InterfaceToken	Token issued to the customer to enable the API	string	Required
Token	JWT token string containing the guests email address.	string	Required
Version	Specify the version number (or 'draft' for draft version) - the returned token will enable access to a particular version of content, If left blank, the current live version is used	string
LanguageCode	Specify the language code for the session - if the language code is empty or null, this is defaulted	string

Request Formats

application/json, text/json

Sample:

{
  "propertyCode": "sample string 1",
  "interfaceToken": "sample string 2",
  "token": "sample string 3",
  "version": "sample string 4",
  "languageCode": "sample string 5"
}

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": "nZ4uCUD-3IgKAAAAAAAAAAAAAAA.KQXgFjpUccK-6M3xS04bUTXrqA7BMTLLD9zlwVn15xk",
  "responsesIncluded": "initialiseSessionResponse,responseStatus",
  "responses": [
    {
      "initialiseSessionResponse": {
        "content": {
          "brandCode": "sample string 1",
          "groupCode": "sample string 2"
        },
        "succeeded": true
      }
    },
    {
      "responseStatus": {
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}