# Calendars

Calendar management

## Fetch a list of Calendars

`GET /calendars`

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

Authentication (security requirement alternatives):

```json
[
  {
    "BasicAuth": []
  },
  {
    "ApiKey": []
  }
]
```

- BasicAuth: http (basic)
- ApiKey: http (bearer)

Parameters:

- `all` (query, boolean, optional) - Can only be used by admins or managers to fetch all entities
  Type: boolean

- `userId` (query, integer, optional) - Standard users can use this only with their own _userId_
  Type: integer

- `limit` (query, integer, optional) - Limit the number of returned results
  Type: integer

- `offset` (query, integer, optional) - Offset for pagination
  Type: integer

- `keyword` (query, string, optional) - Search keyword filter
  Type: string

Responses:

- 200: OK

Content type: application/json

Type: Array<Calendar>

Items:
  Reference: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md); Type: Calendar

- 401: Unauthorized

## Examples

### cURL

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

### JavaScript

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

const data = await response.text();
```

### Python

```python
import requests

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


## Create a Calendar

`POST /calendars`

Authentication (security requirement alternatives):

```json
[
  {
    "BasicAuth": []
  },
  {
    "ApiKey": []
  }
]
```

- BasicAuth: http (basic)
- ApiKey: http (bearer)

Request body: application/json (required)

Type: Calendar

Schema: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md)

- `id` (optional)
  Type: integer, int64
  
  Unique calendar identifier

- `name` (optional)
  Type: string
  
  Calendar display name

- `data` (optional)
  Type: string
  
  base64 encoded in iCalendar format

- `attributes` (optional)
  Type: object
  
  Custom calendar attributes

Responses:

- 200: OK

Content type: application/json

Type: Calendar

Schema: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md)

- `id` (optional)
  Type: integer, int64
  
  Unique calendar identifier

- `name` (optional)
  Type: string
  
  Calendar display name

- `data` (optional)
  Type: string
  
  base64 encoded in iCalendar format

- `attributes` (optional)
  Type: object
  
  Custom calendar attributes

- 400: Bad request

- 401: Unauthorized

## Examples

### cURL

```bash
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": {}
}'
```

### JavaScript

```javascript
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();
```

### Python

```python
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)
```


## Fetch a Calendar

`GET /calendars/{id}`

Authentication (security requirement alternatives):

```json
[
  {
    "BasicAuth": []
  },
  {
    "ApiKey": []
  }
]
```

- BasicAuth: http (basic)
- ApiKey: http (bearer)

Parameters:

- `id` (path, integer, required)
  Type: integer

Responses:

- 200: OK

Content type: application/json

Type: Calendar

Schema: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md)

- `id` (optional)
  Type: integer, int64
  
  Unique calendar identifier

- `name` (optional)
  Type: string
  
  Calendar display name

- `data` (optional)
  Type: string
  
  base64 encoded in iCalendar format

- `attributes` (optional)
  Type: object
  
  Custom calendar attributes

- 401: Unauthorized

- 404: Not found

## Examples

### cURL

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

### JavaScript

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

const data = await response.text();
```

### Python

```python
import requests

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


## Update a Calendar

`PUT /calendars/{id}`

Authentication (security requirement alternatives):

```json
[
  {
    "BasicAuth": []
  },
  {
    "ApiKey": []
  }
]
```

- BasicAuth: http (basic)
- ApiKey: http (bearer)

Parameters:

- `id` (path, integer, required)
  Type: integer

Request body: application/json (required)

Type: Calendar

Schema: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md)

- `id` (optional)
  Type: integer, int64
  
  Unique calendar identifier

- `name` (optional)
  Type: string
  
  Calendar display name

- `data` (optional)
  Type: string
  
  base64 encoded in iCalendar format

- `attributes` (optional)
  Type: object
  
  Custom calendar attributes

Responses:

- 200: OK

Content type: application/json

Type: Calendar

Schema: [Calendar](https://sourcey-traccar.pages.dev/api-reference/models/calendar/index.md)

- `id` (optional)
  Type: integer, int64
  
  Unique calendar identifier

- `name` (optional)
  Type: string
  
  Calendar display name

- `data` (optional)
  Type: string
  
  base64 encoded in iCalendar format

- `attributes` (optional)
  Type: object
  
  Custom calendar attributes

- 400: Bad request

- 401: Unauthorized

## Examples

### cURL

```bash
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": {}
}'
```

### JavaScript

```javascript
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();
```

### Python

```python
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)
```


## Delete a Calendar

`DELETE /calendars/{id}`

Authentication (security requirement alternatives):

```json
[
  {
    "BasicAuth": []
  },
  {
    "ApiKey": []
  }
]
```

- BasicAuth: http (basic)
- ApiKey: http (bearer)

Parameters:

- `id` (path, integer, required)
  Type: integer

Responses:

- 204: No Content

- 401: Unauthorized

## Examples

### cURL

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

### JavaScript

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

const data = await response.text();
```

### Python

```python
import requests

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