Users

Data Schema

Describes the structure of the user data.

Field	Type	Description
id	integer	Unique user identifier
name	string	User's full name
email	string	User's email address
phone	string	User's phone number
readonly	boolean	User has read-only access
administrator	boolean	User has admin privileges
map	string	Default map provider
latitude	number	Default map latitude
longitude	number	Default map longitude
zoom	integer	Default zoom level
password	string	User's password
twelveHourFormat	boolean	Use 12-hour time format
coordinateFormat	string	Coordinate display format
disabled	boolean	Account is disabled
expirationTime	string	Account expiration date
deviceLimit	integer	Maximum number of devices
userLimit	integer	Maximum number of sub-users
deviceReadonly	boolean	Device access is read-only
limitCommands	boolean	Limit command execution
fixedEmail	boolean	Email cannot be changed
poiLayer	string	Points of Interest layer
attributes	object	Additional user attributes

Fetch a List of Users

Retrieves a list of users from the system.

Endpoint:

GET /users

Authorization:

• Requires Basic Authentication (basicAuth)

Query Parameters:

• userId (string) - Can only be used by admin or manager users.

cURL Request Examples:

# Using Basic Auth
curl -u username:password -X GET "https://itsochvts.com/api/users" \
-H "Content-Type: application/json"

# Using Cookie
curl -X GET "https://itsochvts.com/api/users" \
-H "Content-Type: application/json" \
-H "Cookie: JSESSIONID=your_session_id"

Response:

200 OK - Response Body

[
  {
    "id": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "readonly": true,
    "administrator": true,
    "map": "string",
    "latitude": 0,
    "longitude": 0,
    "zoom": 0,
    "password": "string",
    "twelveHourFormat": true,
    "coordinateFormat": "string",
    "disabled": true,
    "expirationTime": "2025-02-18T07:22:23Z",
    "deviceLimit": 0,
    "userLimit": 0,
    "deviceReadonly": true,
    "limitCommands": true,
    "fixedEmail": true,
    "poiLayer": "string",
    "attributes": {}
  }
]

Create a User

Creates a new user in the system.

Endpoint:

POST /users

Authorization:

• Requires Basic Authentication (basicAuth)

cURL Request Examples:

# Using Basic Auth
curl -u username:password -X POST "https://itsochvts.com/api/users" \
-H "Content-Type: application/json" \
-d '{
  "name": "string",
  "email": "string",
  "password": "string"
}'

# Using Cookie
curl -X POST "https://itsochvts.com/api/users" \
-H "Content-Type: application/json" \
-H "Cookie: JSESSIONID=your_session_id" \
-d '{
  "name": "string",
  "email": "string",
  "password": "string"
}'

Request Body:

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "twelveHourFormat": true,
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2025-02-18T07:22:23Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Response:

200 OK - Response Body

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "twelveHourFormat": true,
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2025-02-18T07:22:23Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Update a User

Updates an existing user's information.

Endpoint:

PUT /users/{id}

Authorization:

• Requires Basic Authentication (basicAuth)

Path Parameters:

• id (required, integer) - The ID of the user to update.

cURL Request Examples:

# Using Basic Auth
curl -u username:password -X PUT "https://itsochvts.com/api/users/{id}" \
-H "Content-Type: application/json" \
-d '{
  "name": "string",
  "email": "string"
}'

# Using Cookie
curl -X PUT "https://itsochvts.com/api/users/{id}" \
-H "Content-Type: application/json" \
-H "Cookie: JSESSIONID=your_session_id" \
-d '{
  "name": "string",
  "email": "string"
}'

Request Body:

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "twelveHourFormat": true,
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2025-02-18T07:22:23Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Response:

200 OK - Response Body

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "twelveHourFormat": true,
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2025-02-18T07:22:23Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Delete a User

Removes a user from the system.

Endpoint:

DELETE /users/{id}

Authorization:

• Requires Basic Authentication (basicAuth)

Path Parameters:

• id (required, integer) - The ID of the user to delete.

cURL Request Examples:

# Using Basic Auth
curl -u username:password -X DELETE "https://itsochvts.com/api/users/{id}"

# Using Cookie
curl -X DELETE "https://itsochvts.com/api/users/{id}" \
-H "Cookie: JSESSIONID=your_session_id"

Response:

204 No Content

---