Model Definitions
Session Definition
| Attribute | Type | Required | Description |
|---|---|---|---|
| id | int | For Updates | JSON block ID |
| machineId | int? | No | The ID of the Machine that the Session occurred at. Will be null for sessions originating from non-machine locations. If specified, must be greater than zero. |
| organizationId | int | Yes | Organization ID that the Session belongs to. Must be greater than zero. |
| startedAtUtc | DateTime | Yes | The timestamp of when the session was started. Required on create. Ignored on update: a session's start cannot be changed once created. |
| login | string | No | The login of the person who started the session. Must be 500 or fewer characters in length. |
| reason | string | No | The user specified reason the session was started. Must be 500 or fewer characters in length. |
| loginWasSuccessful | bool | Yes | Indicates whether the users login was valid. |
| endedAtUtc | DateTime? | No | The timestamp of when the session ended. |
| wasAbandoned | bool | Yes | Indicates whether the session was abandoned. |
| source | string | No | The origin of the session. Expected values from VendNovation systems are currently "Service Mode" and "Web". Must be 50 or fewer characters in length. |
Session Source Definitions
| Session Source | Description |
|---|---|
| Service Mode | Indicates origin of the session is the service mode application on a VendNovation touch screen machine. |
| Web | Indicates origin of the session is the vendnovation web client. |
SessionEvent Definition
See the canonical SessionEvent Definition.