Guest Sessions API

Core Guest Sessions API

Majority of the use case for communicating to the T7470 through CoAP involves the Guest Session API which provides a REST interface to managing sessions and session notifications.

What are sessions?

A session can also be known as an order, a person, or a party. Depending on the application, a session is no more than an identifier or event to keep track of and notify if required.

The Guest Sessions API provides the following resources to request:

  • Create a session (POST /v1/sessions)
  • Update/notify a session (PUT /v1/sessions?number=<number>)
  • Remove a session (DELETE /v1/sessions?number=<number>)
  • Retrieve all active sessions GET /v1/sessions
  • Clear all active sessions (DELETE /v1/sessions)
  • Retrieve session history (GET /v1/sessions/history)
  • Retrieve session statistics (GET /v1/sessions/statistics)
  • Clear session statistics (DELETE /v1/sessions/statistics)