Globus Pro
API docs by Redocly

Globus PRO Server API

Download OpenAPI specification:Download

Globus API support: soft-support@elsyton.com License: Copyright SKT-Globus

Dedicated RESTfull endpoints for mobile and frontend clients

Updated: 2024-11-27 10:25:07

Find out documentation for users.

Targets for controllers

authentication-controller - Authentication in system

geozone-controller - Work with geozones

zone-type-controller - Zone types

vehicle-state-controller - State for vehicles

vehicle-controller - Vehicles and devises for it

track-point-controller - Track point

track-controller - Track & Sensor data for track

authentication-controller

Login

query Parameters
interfaceLanguage
string
Enum: "ua" "ru" "en"
username
required
string
password
required
string

Responses

Response samples

Content type
application/json
{
  • "accountType": "string",
  • "blocked": true,
  • "impersonation": true,
  • "message": "string",
  • "lastUpdateRead": true,
  • "belongsTo": "string",
  • "profileDto": {
    },
  • "login": "string",
  • "kind": "string",
  • "capabilities": {
    },
  • "show_hints": true
}

Logout

header Parameters
Authorization
required
string

Responses

Full logout

Responses

Get current username

Responses

Response samples

Content type
application/json
"string"

Check token for expiration

query Parameters
token
required
string

Responses

geozone-controller

Get geozones without 'TASK' type by owner login

query Parameters
login
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create geozones

Request Body schema: application/json
required
Array
id
integer <int64>
name
string
zoneTypeId
integer <int64>
square
number <double>
create
string <date-time>
update
string <date-time>
owner_login
string
object (GeozoneShapeInfoDto)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Delete geozone

query Parameters
id
required
integer <int64>

Responses

Import geozones from kml, kmz, zip

query Parameters
importedCircleRadius
number <double>
Request Body schema: application/json
file
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

zone-type-controller

Get all user and common geozone types without 'TASK' type

query Parameters
locale
required
string
Enum: "UA" "UK_UA" "UK" "RU_UA" "EN" "RU" "RU_RU"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vehicle-state-controller

Get vehicles state for mobile

Responses

Response samples

Content type
application/json
{
  • "vehicleId": 0,
  • "name": "string",
  • "licensePlate": "string",
  • "groups": [
    ],
  • "deviceStatus": "CONNECTED",
  • "vehiclesDataGpsData": {
    },
  • "currentDeviceMapping": {
    },
  • "azimuth": 0.1
}

Get vehicles light state

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "VEHICLE",
  • "name": "string",
  • "owner": "string",
  • "licensePlate": "string",
  • "fixed": true,
  • "groups": [
    ],
  • "vehicleData": {
    }
}

Get vehicles state csv

query Parameters
login
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get vehicle state

path Parameters
vehicleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "vehicleId": 0,
  • "type": "VEHICLE",
  • "name": "string",
  • "owner": "string",
  • "deviceType": "GLOBUS",
  • "deviceStatus": "CONNECTED",
  • "licensePlate": "string",
  • "description": "string",
  • "period1": 0,
  • "period2": 0,
  • "minimalPeriod1": 0,
  • "minimalPeriod2": 0,
  • "returnMinimalPeriod": true,
  • "fixed": true,
  • "tankVolume": 0.1,
  • "tankVolumeStart": 0.1,
  • "lastKnownTime": "2019-08-24T14:15:22Z",
  • "groups": [
    ],
  • "currentDeviceMapping": {
    },
  • "rfidCardIds": [
    ],
  • "vehiclesDataGpsDataDto": {
    },
  • "inputsValues": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "valuesChangedMask": 0,
  • "values": 0,
  • "powerRestored": true,
  • "lockedAlarm": true,
  • "alarm": true,
  • "multiSensorValues": [
    ],
  • "realSensorValues": [
    ],
  • "antStatus": {
    },
  • "lockStateDto": {
    },
  • "eventsCountPerDay": {
    },
  • "logicalInputStatuses": [
    ],
  • "trailerActionEvent": {
    },
  • "connectedRfidCard": {
    },
  • "azimuth": 0.1,
  • "settings": [
    ],
  • "vehicleCounters": [
    ],
  • "vehicleSensorControlDtoList": [
    ],
  • "virtualSensors": [
    ],
  • "multiSensors": [
    ],
  • "realSensorSockets": [
    ]
}

vehicle-controller

Get vehicleIds to deviceIds by user

Responses

Response samples

Content type
application/json
{
  • "vehicleId": 0,
  • "deviceId": 0
}

track-point-controller

Get last track point by vehicle id

query Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "multiSensorValues": [
    ],
  • "realSensorValues": [
    ],
  • "fuelData": {
    },
  • "deviceEvents": [
    ],
  • "dispenserStatuses": {
    },
  • "logicalInputStatuses": [
    ],
  • "mileage": 0.1,
  • "timeInterval": 0,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "speedMoreThanZero": true,
  • "gpsData": {
    },
  • "events": [
    ]
}

track-controller

Get vehicle gps data

query Parameters
controlEntityId
required
integer <int64>
applyIgnition
boolean
Default: true
from
required
string <date-time>
to
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get track with track with all data, but with only fuel and flow meter sensors

query Parameters
vehicleId
required
integer <int64>
applyIgnition
boolean
Default: true
from
required
string <date-time>
to
required
string <date-time>
polynomialDegree
integer <int32>
applyApproximation
boolean
Default: false
mileageAlgorithmType
string
Enum: "DEFAULT" "HAVERSINE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get vehicle sensors

query Parameters
controlEntityId
required
integer <int64>
from
required
string <date-time>
to
required
string <date-time>
realSensorSocketIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "realSensorValues": {
    },
  • "multiSensorValues": {
    }
}