Depending on the current user, the list of available commands may vary; however, a number of commands must work through the session. The table below presents a list of possible commands, requirements for session use, and the availability of functions depending on the type of work selected.
Table 97.
| Command | Description | Session use | SDK password | Any user |
| /login | create a new session | Not required | + | + |
| /health | output the server's health | Not required | + | + |
| /settings | read and write server settings | Not required | + | + |
| /objects |
output the server's object tree implementing various methods to the server objects |
Not required | + | - |
| /classes | output a description of the server's objects' classes | Not required | + | - |
| /users | creating users and user groups | Not required | + | - |
| /channels | quickly output the list of channels | Required | - | + |
| /events | get server events | Not required | + | - |
| /pos_events | get POS-terminal events | Not required | + | - |
| /lpr_events | get AutoTRASSIR events | Not required | + | - |
| /fr_events | receiving tracker/face recognizer events | Required | + | - |
| /screenshot | request a screenshot | Not required | + | - |
| /ptz | control a PTZ camera | Required | - | + |
| /archive_status | output the archive state | Required | - | + |
| /archive_command | control an archive | Required | - | + |
| /archive_events | archive events request | Required | - | + |
| /get_video | get a link to a video | Required | - | + |
|
/archive_export /archive_export_ss /archive_export_ex /export_archive /export_task /export_cancel |
local archive export | Required | + | + |
|
/jit-export-task /jit-export-status /jit-export-download /jit-export-cancel-task |
remote archive export | Required | + | + |
Tip
When working with the login/password in the request, each time the response to the /events, /pos_events, /lpr_events and /fr_events commands will contain last 100 events.
When working through a session, the first request will return the last 100 events, while all subsequent requests will return only the new events since the last request. If no events arrive for a long time, the operation will timeout.
Tip
Note that the TRASSIR SDK does not perform a database search for events, rather it returns only those events that have accumulated since the automation module was started.
We also recommend you to get acquainted with more detailed commands description and usage examples.
