Fleet setup

Calendars

Calendar management

Fetch a list of Calendars

GET

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

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

Fetch a list of Calendars

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

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

const data = await response.text();

import requests

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

200

[
  {
    "id": 0,
    "name": "string",
    "data": "string",
    "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

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Calendar>

Response fields application/json

Array<Calendar>

Show child attributes

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Calendar

POST

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

Create a Calendar

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

const body = `{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

Response

200OKCalendar

Response fields application/json

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Calendar

GET

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

Fetch a Calendar

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

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKCalendar

Response fields application/json

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Calendar

PUT

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

Update a Calendar

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

const body = `{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "data": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

Parameters

idintegerrequiredpath

Response

200OKCalendar

Response fields application/json

idinteger<int64>

Unique calendar identifier

namestring

Calendar display name

datastring

base64 encoded in iCalendar format

attributesobject

Custom calendar attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Calendar

DELETE

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

Delete a Calendar

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

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

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/calendars/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