Server API

The Server API provides essential configuration details and allows updates to the server settings.

Data Schema

Describes the structure of the server configuration data.

Field	Type	Description
`id`	`integer`	Unique server identifier
`registration`	`boolean`	Whether registration is enabled
`readonly`	`boolean`	Server in read-only mode
`deviceReadonly`	`boolean`	Devices in read-only mode
`limitCommands`	`boolean`	Limits the number of commands
`map`	`string`	Default map provider
`bingKey`	`string`	Bing Maps API key
`mapUrl`	`string`	Custom map URL
`poiLayer`	`string`	Points of Interest layer name
`latitude`	`number`	Default map latitude
`longitude`	`number`	Default map longitude
`zoom`	`integer`	Default zoom level
`twelveHourFormat`	`boolean`	Use 12-hour time format
`version`	`string`	Server version number
`forceSettings`	`boolean`	Force server settings
`coordinateFormat`	`string`	Coordinate display format
`openIdEnabled`	`boolean`	Enable OpenID authentication
`openIdForce`	`boolean`	Force OpenID authentication
`attributes`	`object`	Additional server attributes

Server Information

Fetch Server Information

Retrieves the current server configuration details.

🛠 Endpoint:

GET /server

Authorization:

Requires Basic Authentication (basicAuth)

cURL Request:

curl -u username:password -X GET "https://itsochvts.com/api/server" \
-H "Content-Type: application/json" \
-H "Cookie: JSESSIONID=your_session_id"

Response:

200 OK - Response Body

{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "twelveHourFormat": true,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}

Update Server Information

Updates the server settings with new configuration values.

🛠 Endpoint:

PUT /server

Authorization:

Requires Basic Authentication (basicAuth)

cURL Request:

curl -u username:password -X PUT "https://itsochvts.com/api/server" \
-H "Content-Type: application/json" \
-H "Cookie: JSESSIONID=your_session_id" \
-d '{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "twelveHourFormat": true,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}'

Request Body:

  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "twelveHourFormat": true,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}

Response:

200 OK - Response Body

{
  "id": 0,
  "registration": true,
  "readonly": true,
  "deviceReadonly": true,
  "limitCommands": true,
  "map": "string",
  "bingKey": "string",
  "mapUrl": "string",
  "poiLayer": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "twelveHourFormat": true,
  "version": "string",
  "forceSettings": true,
  "coordinateFormat": "string",
  "openIdEnabled": true,
  "openIdForce": true,
  "attributes": {}
}