In addition to the standard required HTTP headers (Host and Date), the Availability API allows the following HTTP headers:

  • Accept – The accept header determines the output format of the response. The acceptable values are application/jsonapplication/xml and application/x-json-stream.
  • x-summon-session-id – As with all summon requests, the Availability API supports the Summon session ID header, which allows separate API calls to be tied to individual user sessions. A custom session ID may be provided as follows:
    • If the UI already tracks a session for the user.
    • If a custom session ID is not provided on the first call to the API, the API will generate and return a session ID.

    The session ID should be passed with all future requests made in the same user session.