The session will be sent to the device identified by its Unit ID. The session will remain in the database on the server. When the device sends the session back, the updated session will replace the record in the server database.

If the device is connected, the session will be sent immediately. Otherwise the session will be queued and sent to the device when it next connects.

Params

Param name Description
project_id
optional

The project identifier

Validations:

  • Must be a Fixnum

session_id
optional

The UUID of the session

Validations:

  • Must be a String

unit_id
optional

The Unit ID of the device that will receive the session.

Validations:

  • Must be a String

session_type
optional

Determines if the original session or a new duplicate is sent. Options: ‘duplicate’ | ‘original’. Default: ‘original’

Validations:

  • Must be a String

include_sub_sessions
optional

Determines if sub sessions (from sub project) will be sent as well. Options: true | false. Default: false

Validations:

  • Must be a Boolean