API docs by Redocly

Axenta API (v1)

Download OpenAPI specification:Download

Authorization

Log in

User authentication

Request Body schema: application/json
required
username
required
string (Username) non-empty
password
required
string (Password) >= 6 characters

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

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

CMS (only for partners)

List of accounts

List of accounts

Authorizations:
Token
query Parameters
ordering
string

Which field to use when ordering the results.

type
string

Type of account

children
string

Children accounts

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create new account.

Create new account.

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
type
string (Type)
Enum: "client" "partner"
adminId
required
integer (Admin id)
comment
string or null (Comment)
blockingDatetime
string or null <date-time> (Blocking date)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "client",
  • "adminId": 0,
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "client",
  • "adminId": 0,
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Get account by ID.

Get account by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "client",
  • "adminFullname": "string",
  • "parentAccountName": "string",
  • "objectsActive": 0,
  • "objectsTotal": 0,
  • "comment": "string",
  • "isActive": true,
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Update account by ID.

Update account by ID.

Authorizations:
Token
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
type
string (Type)
Enum: "client" "partner"
object (User)
comment
string or null (Comment)
blockingDatetime
string or null <date-time> (Blocking date)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "client",
  • "admin": {
    },
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "client",
  • "admin": {
    },
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Partial update account by ID.

Partial update account by ID.

Authorizations:
Token
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
type
string (Type)
Enum: "client" "partner"
object (User)
comment
string or null (Comment)
blockingDatetime
string or null <date-time> (Blocking date)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "client",
  • "admin": {
    },
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "client",
  • "admin": {
    },
  • "comment": "string",
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Delete account by ID.

Delete account by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses

Activate/deactivate account.

Activate/deactivate account.

Authorizations:
Token
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
type
string (Type)
Enum: "client" "partner"
adminFullname
string (Admin fullname) non-empty
parentAccountName
string (Parent account name) non-empty
comment
string or null (Comment)
isActive
boolean (Status)
blockingDatetime
string or null <date-time> (Blocking date)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "client",
  • "adminFullname": "string",
  • "parentAccountName": "string",
  • "comment": "string",
  • "isActive": true,
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "client",
  • "adminFullname": "string",
  • "parentAccountName": "string",
  • "objectsActive": 0,
  • "objectsTotal": 0,
  • "comment": "string",
  • "isActive": true,
  • "blockingDatetime": "2019-08-24T14:15:22Z"
}

List of object with objects from children accounts in account.

List of object in account.

Authorizations:
Token
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Get object by ID.

Get object by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uniqueId": "string",
  • "creatorName": "string",
  • "accountName": "string",
  • "phoneNumbers": [
    ],
  • "deviceTypeName": "string",
  • "lastMessageDatetime": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isActive": true
}

Delete object by ID.

Delete object by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses

Activate/deactivate object.

Activate/deactivate object.

Authorizations:
Token
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
uniqueId
required
string (Unique ID) [ 1 .. 255 ] characters
creatorName
required
string (Creator name) non-empty
accountName
required
string (Account name) non-empty
phoneNumbers
required
Array of strings or null
lastMessageDatetime
string <date-time> (Last message datetime)
isActive
boolean (Status)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "uniqueId": "string",
  • "creatorName": "string",
  • "accountName": "string",
  • "phoneNumbers": [
    ],
  • "lastMessageDatetime": "2019-08-24T14:15:22Z",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uniqueId": "string",
  • "creatorName": "string",
  • "accountName": "string",
  • "phoneNumbers": [
    ],
  • "deviceTypeName": "string",
  • "lastMessageDatetime": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isActive": true
}

Objects

List of object in account

List of objects.

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Get object by ID.

Get object by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "deviceTypeId": "string",
  • "lastMessage": "string",
  • "id": 0,
  • "sensors": "string",
  • "drivers": "string",
  • "connectedStatus": "string",
  • "name": "string",
  • "objectTypeId": "car",
  • "deviceType": 0,
  • "uniqueId": "string",
  • "phoneNumber": [
    ],
  • "password": "string",
  • "creator": 0,
  • "account": 0,
  • "iconId": -2147483648,
  • "objectIconColor": "string",
  • "normalConsumption100": -2147483648,
  • "citySpeedLimit": -2147483648,
  • "maxIntervalBetweenMessages": -2147483648,
  • "mileageFactor": 1,
  • "speedLimitType": "string",
  • "speedLimitParams": { },
  • "objectCaptionColor": "string",
  • "trackColor": { },
  • "customFields": { },
  • "tripDetector": { },
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete object by ID.

Delete object by ID.

Authorizations:
Token
path Parameters
id
required
string

Responses