Events Server API 1.1.16

Async API (via websockets) for intercomponent communication

Connection details

URL Scheme Description
events-service-dev.eu-west-2.elasticbeanstalk.com wss

Development Environment Server

events-service-int.eu-west-2.elasticbeanstalk.com wss

Integration Environment Server

Topics

Publish command.topicConnect

Connect to a topic

The first client to connect on this topic will create a socket "room". Any subsequent client connecting with the same topic name will join this "room". Note, the permissions (authority) of the token will dictate whether a client can create a topic or not. For example, a UI client cannot create a topic for a device if the device client has not connected first

Payload

Name Type Description
token string JSON Web Token
topic string topic - e.g device123 (device specific topic)

Tags

No tags

Publish command.topicDisconnect

Disconnect a topic

When the last client leaves the room (or disconnects from socket server), the topic will be removed

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)

Tags

No tags

event.clientConnectionStatus

Listen for topic client connection changes

Fired when a client sucessfully connects to or disconnects from a topic. Note, the client will have to be connected to the "connectionsTopic" to listen for these events. the clients token will dictate if the socket client has permission (authority) to connect to the topic.

Payload

Name Type Description
token string Json Web Token of client
topicId string unique topic ID
topic string topic name being connected to or disconnected from
connected boolean true is a client has connected to topic, false if disconnecting
first boolean true if this client created this topic

Tags

No tags

Publish command.boardingStatus

Notify boarding state change for a particular device.

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string clients Json Web Token
sessionId string unique id for the boarding session
statusMsg string descriptive message status (could be pax status...e.g. not recognized or system Status - camera not responding, etc)
boardingStatus integer 0 - Ready, 1- FlightClosed, 2 - FlightOpen, 3 - PaxNonCompliant, 4 - PaxCompliant, 5 - MatchRequest, 6 - Boarding, 7 - Boarded, 8 - RedirecttoAgent, 9 - NoPaxDetected, 10 - OpenFlightRequest, 11 - ReadyToBoard, 12 - Uploading, 13 - Uploaded
boardingStatusPayload object
flightData object
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)
passengerData object
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

Tags

No tags

event.boardingStatus

Notify boarding state change for a particular device.

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string clients Json Web Token
sessionId string unique id for the boarding session
statusMsg string descriptive message status (could be pax status...e.g. not recognized or system Status - camera not responding, etc)
boardingStatus integer 0 - Ready, 1- FlightClosed, 2 - FlightOpen, 3 - PaxNonCompliant, 4 - PaxCompliant, 5 - MatchRequest, 6 - Boarding, 7 - Boarded, 8 - RedirecttoAgent, 9 - NoPaxDetected, 10 - OpenFlightRequest, 11 - ReadyToBoard, 12 - Uploading, 13 - Uploaded
boardingStatusPayload object
flightData object
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)
passengerData object
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

Tags

No tags

Publish command.deviceStatus

Notify device state change

when device is registered, online, etc

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
status string connected, disconnected, fail
reason string optional reason for status
updateTime string when this device status change occured (in UTC)

Tags

No tags

event.deviceStatus

Notify device state change

when device is registered, online, etc

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
status string connected, disconnected, fail
reason string optional reason for status
updateTime string when this device status change occured (in UTC)

Tags

No tags

Publish command.messageWarning

Notify of incorrect or unexpected web socket traffic

For example, messages missing data or received in unexpected order

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
message string the warning/error message

Tags

No tags

event.messageWarning

Notify of incorrect or unexpected web socket traffic

For example, messages missing data or received in unexpected order

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
message string the warning/error message

Tags

No tags

Publish command.deviceUpdate

Notify device that software or configuration needs to be updated

Actual update will be pulled by remote device. This just lets device know that there is an update

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string Json Web Token of client
updatePayload object
type string xml, json, etc
path string where to pull the update files
credentials string base64 encoded string of credentials to send when pulling update files

Tags

No tags

event.deviceUpdate

Notify device that software or configuration needs to be updated

Actual update will be pulled by remote device. This just lets device know that there is an update

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string Json Web Token of client
updatePayload object
type string xml, json, etc
path string where to pull the update files
credentials string base64 encoded string of credentials to send when pulling update files

Tags

No tags

Messages

topicConnect

Connect to a topic

The first client to connect on this topic will create a socket "room". Any subsequent client connecting with the same topic name will join this "room". Note, the permissions (authority) of the token will dictate whether a client can create a topic or not. For example, a UI client cannot create a topic for a device if the device client has not connected first

Payload

Name Type Description
token string JSON Web Token
topic string topic - e.g device123 (device specific topic)

topicDisconnect

Disconnect a topic

When the last client leaves the room (or disconnects from socket server), the topic will be removed

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)

clientConnectionStatus

Listen for topic client connection changes

Fired when a client sucessfully connects to or disconnects from a topic. Note, the client will have to be connected to the "connectionsTopic" to listen for these events. the clients token will dictate if the socket client has permission (authority) to connect to the topic.

Payload

Name Type Description
token string Json Web Token of client
topicId string unique topic ID
topic string topic name being connected to or disconnected from
connected boolean true is a client has connected to topic, false if disconnecting
first boolean true if this client created this topic

boardingStatus

Notify boarding state change for a particular device.

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string clients Json Web Token
sessionId string unique id for the boarding session
statusMsg string descriptive message status (could be pax status...e.g. not recognized or system Status - camera not responding, etc)
boardingStatus integer 0 - Ready, 1- FlightClosed, 2 - FlightOpen, 3 - PaxNonCompliant, 4 - PaxCompliant, 5 - MatchRequest, 6 - Boarding, 7 - Boarded, 8 - RedirecttoAgent, 9 - NoPaxDetected, 10 - OpenFlightRequest, 11 - ReadyToBoard, 12 - Uploading, 13 - Uploaded
boardingStatusPayload object
flightData object
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)
passengerData object
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

deviceUpdate

Notify device that software or configuration needs to be updated

Actual update will be pulled by remote device. This just lets device know that there is an update

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string Json Web Token of client
updatePayload object
type string xml, json, etc
path string where to pull the update files
credentials string base64 encoded string of credentials to send when pulling update files

deviceStatus

Notify device state change

when device is registered, online, etc

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
status string connected, disconnected, fail
reason string optional reason for status
updateTime string when this device status change occured (in UTC)

messageWarning

Notify of incorrect or unexpected web socket traffic

For example, messages missing data or received in unexpected order

Payload

Name Type Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
message string the warning/error message

Schemas

topicConnectPayload

Name Title Type Format Default Description
token string JSON Web Token
topic string topic - e.g device123 (device specific topic)

topicDisconnectPayload

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)

topicConnectionPayload

Name Title Type Format Default Description
token string Json Web Token of client
topicId string unique topic ID
topic string topic name being connected to or disconnected from
connected boolean true is a client has connected to topic, false if disconnecting
first boolean true if this client created this topic

publishEventPayload

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)
eventType string event type (e.g. boardingStatus, deviceStatus, deviceConfiguration, etc...i.e. should match subscribe messages
eventPayload object data associated with event (will vary according to eventType - refer to subscriber message payloads for details

deviceUpdatePayload

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)
token string Json Web Token of client
updatePayload object
type string xml, json, etc
path string where to pull the update files
credentials string base64 encoded string of credentials to send when pulling update files

topic

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)

eventType

Name Title Type Format Default Description
eventType string event type (e.g. boardingStatus, deviceStatus, deviceConfiguration, etc...i.e. should match subscribe messages

eventPayload

Name Title Type Format Default Description
eventPayload object data associated with event (will vary according to eventType - refer to subscriber message payloads for details

updatePayload

Name Title Type Format Default Description
type string xml, json, etc
path string where to pull the update files
credentials string base64 encoded string of credentials to send when pulling update files

boardingStatus

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)
token string clients Json Web Token
sessionId string unique id for the boarding session
statusMsg string descriptive message status (could be pax status...e.g. not recognized or system Status - camera not responding, etc)
boardingStatus integer 0 - Ready, 1- FlightClosed, 2 - FlightOpen, 3 - PaxNonCompliant, 4 - PaxCompliant, 5 - MatchRequest, 6 - Boarding, 7 - Boarded, 8 - RedirecttoAgent, 9 - NoPaxDetected, 10 - OpenFlightRequest, 11 - ReadyToBoard, 12 - Uploading, 13 - Uploaded
boardingStatusPayload object
flightData object
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)
passengerData object
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

boardingStatusPayload

Name Title Type Format Default Description
flightData object
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)
passengerData object
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

passengerDataPayload

Name Title Type Format Default Description
base64Image string base 64 encoded image data
faceId string id to help correlate match/board request-response
name string Passenger Name
seat string Seat Number assignment for passenger
seq string Passenger Sequence number
ssrs array list of special service request (SSR) codes for passenger
data array
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

displayData

Name Title Type Format Default Description
name string name of the data property
value string value of the data property
style string style to be applied to data (error, standard, etc)

flightDataPayload

Name Title Type Format Default Description
carrierCode string Airline Code (IATA)
flightNumber string Flight number
scheduledDate string Scheduled date of departure
origin string Originating airport
destination string Destination airport
location string Location Description (e.g. Gate C14)

socketWarningPayload

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
message string the warning/error message

deviceStatusPayload

Name Title Type Format Default Description
topic string topic - e.g device123 (device specific topic)
token string JSON web token
status string connected, disconnected, fail
reason string optional reason for status
updateTime string date-time when this device status change occured (in UTC)