Fleet setup

Maintenance

Maintenance management

Fetch a list of Maintenance tasks

GET

https://demo.traccar.org/api/maintenance

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

Fetch a list of Maintenance tasks

curl -X GET 'https://demo.traccar.org/api/maintenance' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/maintenance', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/maintenance',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "name": "string",
    "type": "string",
    "start": 0,
    "period": 0,
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

deviceIdintegerquery

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

groupIdintegerquery

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

refreshbooleanquery

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Maintenance>

Response fields application/json

Array<Maintenance>

Show child attributes

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Maintenance task

POST

https://demo.traccar.org/api/maintenance

Create a Maintenance task

curl -X POST 'https://demo.traccar.org/api/maintenance' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/maintenance', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}'''

response = requests.post(
    'https://demo.traccar.org/api/maintenance',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

Response

200OKMaintenance

Response fields application/json

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Maintenance task

GET

https://demo.traccar.org/api/maintenance/{id}

Fetch a Maintenance task

curl -X GET 'https://demo.traccar.org/api/maintenance/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/maintenance/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/maintenance/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKMaintenance

Response fields application/json

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Maintenance task

PUT

https://demo.traccar.org/api/maintenance/{id}

Update a Maintenance task

curl -X PUT 'https://demo.traccar.org/api/maintenance/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/maintenance/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/maintenance/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "type": "string",
  "start": 0,
  "period": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

Parameters

idintegerrequiredpath

Response

200OKMaintenance

Response fields application/json

idinteger<int64>

Unique maintenance item identifier

namestring

Maintenance task name

typestring

Metric the maintenance is based on

startnumber

Current accumulated value when maintenance tracking starts

periodnumber

Threshold value after which maintenance is due

attributesobject

Custom maintenance attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Maintenance task

DELETE

https://demo.traccar.org/api/maintenance/{id}

Delete a Maintenance task

curl -X DELETE 'https://demo.traccar.org/api/maintenance/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/maintenance/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/maintenance/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey