Documentation Powered by Redocly

AjnaView (1.36)

AjnaView Support: info@ajnaview.net URL: https://www.ajnaview.net/

AjnaView GPS Asset tracking server API documentation.

Devices

Device management

Get a list of Devices

Without any params, returns a list of the user's devices

Authorizations:
basicAuth
query Parameters
all
boolean

Can only be used by admins to get all entities

userId
integer

Standard users can use this only with their own userId

id
integer

To get one or more devices. Multiple params can be passed like id=11&id=32

uniqueId
string

To get one or more devices. Multiple params can be passed like uniqueId=345331&uniqieId=43442

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Positions

Fetch raw location information

Get a list of Positions

Without any params, it returns a list of last known positions for all the user's Devices. from and to fields are not required with id.

Authorizations:
basicAuth
query Parameters
deviceId
integer

deviceId is optional, but requires the from and to parameters when used

from
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

id
integer

To get one or more positions. Multiple params can be passed like id=21&id=42

Responses

Response samples

Content type
[
  • {
    }
]

Events

Fetch event information

/events/{id}

Authorizations:
basicAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "eventTime": "2019-08-24T14:15:22Z",
  • "deviceId": 0,
  • "positionId": 0,
  • "geofenceId": 0,
  • "maintenanceId": 0,
  • "attributes": { }
}

Reports

Reports generation

Get a list of Positions within the time period for the Devices or Groups

At least one deviceId or one groupId must be passed

Authorizations:
basicAuth
query Parameters
deviceId
Array of integers
groupId
Array of integers
from
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

Responses

Response samples

Content type
[
  • {
    }
]

Get a list of Events within the time period for the Devices or Groups

At least one deviceId or one groupId must be passed

Authorizations:
basicAuth
query Parameters
deviceId
Array of integers
groupId
Array of integers
type
Array of strings

% can be used to return events of all types

from
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

Responses

Response samples

Content type
[
  • {
    }
]

Get a list of ReportSummary within the time period for the Devices or Groups

At least one deviceId or one groupId must be passed

Authorizations:
basicAuth
query Parameters
deviceId
Array of integers
groupId
Array of integers
from
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

Responses

Response samples

Content type
[
  • {
    }
]

Get a list of ReportTrips within the time period for the Devices or Groups

At least one deviceId or one groupId must be passed

Authorizations:
basicAuth
query Parameters
deviceId
Array of integers
groupId
Array of integers
from
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

Responses

Response samples

Content type
[
  • {
    }
]

Get a list of ReportStops within the time period for the Devices or Groups

At least one deviceId or one groupId must be passed

Authorizations:
basicAuth
query Parameters
deviceId
Array of integers
groupId
Array of integers
from
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

to
required
string <date-time>

in IS0 8601 format. eg. 2021-10-12T15:10:00Z

Responses

Response samples

Content type
[
  • {
    }
]

Notifications

User notifications management

Get a list of Notifications

Without params, it returns a list of Notifications the user has access to

Authorizations:
basicAuth
query Parameters
all
boolean

Can only be used by admins to get all entities

userId
integer

Standard users can use this only with their own userId

deviceId
integer

Standard users can use this only with _deviceId_s, they have access to

groupId
integer

Standard users can use this only with _groupId_s, they have access to

refresh
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of available Notification types

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Geofences

Get a list of Geofences

Without params, it returns a list of Geofences the user has access to

Authorizations:
basicAuth
query Parameters
all
boolean

Can only be used by admins to get all entities

userId
integer

Standard users can use this only with their own userId

deviceId
integer

Standard users can use this only with _deviceId_s, they have access to

groupId
integer

Standard users can use this only with _groupId_s, they have access to

refresh
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Get a list of Employees/Drivers

Without params, it returns a list of Employees/Drivers the user has access to

Authorizations:
basicAuth
query Parameters
all
boolean

Can only be used by admins to get all entities

userId
integer

Standard users can use this only with their own userId

deviceId
integer

Standard users can use this only with _deviceId_s, they have access to

groupId
integer

Standard users can use this only with _groupId_s, they have access to

refresh
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]