IREX
EN

Step 1: Select a User Group

The first thing to do is to select a user group that is going to be tasked with tracking the plate. Select it on the consolidated or limited user group list. To obtain such list, run the request ...

GET Request GET Request Sample
/api/v1/usergroups

... with the optional parameters:

user_id

Optional

$int32

Use it when the identifier of the operator tasked with tracking the plate is known. The request returns the list of groups the operator is a member of.

user_group_level_id

OPTIONAL

$int32
Use it when the searched user group level code in the group hierarchy is known.

text

OPTIONAL

string
Use it when a fragment of the searched group's name is known

node_id

OPTIONAL

$int32
Use it when the searched user node code in the group hierarchy is known.

The request returns an array of UserGroup JSON object, each holding the description of a group that matched the request condition, for example:

{
    "id": 0, // The required identifier
    "name": "string",
    "parent_id": 0,
    "has_child": true,
    "permissions": [
      "CREATE_CHANNEL"
    ],
    "root": false
  }

Select the required id among all the id-s in the UserGroup array to use it at step 2.