Calendar
TIP
Calendars belong to Zammad's SLA calculation.
List
Required permission: admin.calendar
GET-Request sent: /api/v1/calendars
Show response
json
// HTTP-Code 200 OK
[
{
"id": 2,
"name": "Test calendar",
"timezone": "Europe/Berlin",
"business_hours": {
"mon": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"tue": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"wed": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"thu": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"fri": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"sat": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
},
"sun": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
}
},
"default": false,
"ical_url": "",
"public_holidays": {
"2021-11-10": {
"active": true,
"summary": "Feast day 1"
},
"2021-11-11": {
"active": true,
"summary": "Feast day 2"
}
},
"last_log": null,
"last_sync": "2021-11-10T13:14:20.835Z",
"updated_by_id": 3,
"created_by_id": 3,
"created_at": "2021-11-10T13:14:20.835Z",
"updated_at": "2021-11-10T13:14:20.835Z"
}
]Show
Required permission: admin.calendar
GET-Request sent: /api/v1/calendars/{id}
Show response
json
// HTTP-Code 200 OK
{
"id": 2,
"name": "Test calendar",
"timezone": "Europe/Berlin",
"business_hours": {
"mon": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"tue": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"wed": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"thu": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"fri": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"sat": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
},
"sun": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
}
},
"default": false,
"ical_url": "",
"public_holidays": {
"2021-11-10": {
"active": true,
"summary": "Feast day 1"
},
"2021-11-11": {
"active": true,
"summary": "Feast day 2"
}
},
"last_log": null,
"last_sync": "2021-11-10T13:14:20.835Z",
"updated_by_id": 3,
"created_by_id": 3,
"created_at": "2021-11-10T13:14:20.835Z",
"updated_at": "2021-11-10T13:14:20.835Z"
}Create
Required permission: admin.calendar
POST-Request sent: /api/v1/calendars
Show request/response
json
{
"name": "Test calendar",
"timezone": "Europe/Berlin",
"business_hours": {
"mon": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"tue": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"wed": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"thu": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"fri": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"sat": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
},
"sun": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
}
},
"ical_url": "",
"public_holidays": {
"2021-11-10": {
"active": true,
"summary": "Feast day 1"
},
"2021-11-11": {
"active": true,
"summary": "Feast day 2"
}
},
"note": "",
"id": "c-1"
}Update
Required permission: admin.calendar
PUT-Request sent: /api/v1/calendars/{id}
Show request/response
json
{
"name": "Test calendar Update",
"timezone": "Europe/Berlin",
"default": false,
"business_hours": {
"mon": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"tue": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"wed": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"thu": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"fri": {
"active": true,
"timeframes": [
[
"09:00",
"17:00"
]
]
},
"sat": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
},
"sun": {
"active": false,
"timeframes": [
[
"10:00",
"14:00"
]
]
}
},
"ical_url": "",
"public_holidays": {
"2021-11-10": {
"active": true,
"summary": "Feast day 1"
},
"2021-11-11": {
"active": true,
"summary": "Feast day 2"
}
},
"note": "",
"id": 2
}Delete
Required permission: admin.calendar
DELETE-Request sent: /api/v1/calendars/{id}
DANGER
This is a permanent removal:
Please note that removing Calendar configurations cannot be undone.
Removing calendars with references in SLA configurations is not possible via API - this will be indicated by "error": "Can't delete, object has references.". This is not a bug.
Show response
json
// HTTP-Code 200 OK
{}