Appointment API specification (1.21.2)

Download OpenAPI specification:Download

The appointment service implements all appointment and reminder functions for GroupAlarm

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: Personal-Access-Token

appointment

CreateAppointment

Create an appointment with the passed parameters

Request Body schema: application/json
creator
integer <int64>
description
string
endDate
string <date-time>
id
integer <int64>
name
string
organizationID
integer <int64>
participants
Array of object (AppointmentParticipant)
startDate
string <date-time>

Responses

201

Appointment successfully created

500

database error

post /appointment
https://app.groupalarm.com/api/v1/appointment

Request samples

application/json
Copy
Expand all Collapse all
{
  • "creator": 0,
  • "description": "string",
  • "endDate": "2019-09-20T12:49:32Z",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "participants":
    [
    ],
  • "startDate": "2019-09-20T12:49:32Z"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "creator": 0,
  • "description": "string",
  • "endDate": "2019-09-20T12:49:32Z",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "participants":
    [
    ],
  • "startDate": "2019-09-20T12:49:32Z"
}

GetAppointment

Get specific appointment with the requested id

path Parameters
id
required
int64

id of an appointment

Responses

200

Requested appointment with the passed id

500

database error

get /appointment/{id}
https://app.groupalarm.com/api/v1/appointment/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "creator": 0,
  • "description": "string",
  • "endDate": "2019-09-20T12:49:32Z",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "participants":
    [
    ],
  • "startDate": "2019-09-20T12:49:32Z"
}

UpdateAppointment

Update an appointment with the passed parameters

path Parameters
id
required
int64

id of an appointment

Request Body schema: application/json
creator
integer <int64>
description
string
endDate
string <date-time>
id
integer <int64>
name
string
organizationID
integer <int64>
participants
Array of object (AppointmentParticipant)
startDate
string <date-time>

Responses

200

Appointment was successfully updated

500

database error

put /appointment/{id}
https://app.groupalarm.com/api/v1/appointment/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "creator": 0,
  • "description": "string",
  • "endDate": "2019-09-20T12:49:32Z",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "participants":
    [
    ],
  • "startDate": "2019-09-20T12:49:32Z"
}

DeleteAppointment

Deletes the appointment with the passed id

path Parameters
id
required
int64

id of an appointment

Responses

200

Appointment was successfully deleted

500

database error

delete /appointment/{id}
https://app.groupalarm.com/api/v1/appointment/{id}

UpdateAppointmentParticipantFeedback

Update an appointment with the passed parameters

path Parameters
id
required
int64

id of an appointment

Request Body schema: application/json
appointmentID
integer <int64>
feedback
integer <int64> (AppointmentFeedbackStatus)

AppointmentFeedbackStatus describes the current feedback status of an user

feedbackMessage
string
userID
integer <int64>

Responses

200

Appointment was successfully updated

500

database error

put /appointment/{id}/feedback
https://app.groupalarm.com/api/v1/appointment/{id}/feedback

Request samples

application/json
Copy
Expand all Collapse all
{
  • "appointmentID": 0,
  • "feedback": 0,
  • "feedbackMessage": "string",
  • "userID": 0
}

appointments

GetPersonalAppointments

Get paginated personal appointments

query Parameters
limit
int64

max. amount of entries in list

offset
int64

amount of entries to skip

Responses

200

Paginated appointments for this user

500

database error

get /appointments
https://app.groupalarm.com/api/v1/appointments

Response samples

application/json
Copy
Expand all Collapse all
{
  • "appointments":
    [
    ],
  • "totalAppointments": 0
}

GetPersonalICal

Returns all personal appointments in ical/ics format

path Parameters
token
required
text

token to access personal appointments

Responses

200

Personal appointments in ical/ics format

500

database error

get /appointments/ical/personal/{token}
https://app.groupalarm.com/api/v1/appointments/ical/personal/{token}

UpsertPersonalToken

Get personal ical token

Responses

200

Personal token to access personal appointments

500

database error

get /appointments/ical/token/personal
https://app.groupalarm.com/api/v1/appointments/ical/token/personal

Response samples

application/json
Copy
Expand all Collapse all
{
  • "token": "string"
}

UpsertPersonalToken

Creates or updates the personal ical token

path Parameters
token
required
text

token to access personal appointments

Responses

200

Created token to access the personal appointments in ics format

500

database error

post /appointments/ical/token/personal
https://app.groupalarm.com/api/v1/appointments/ical/token/personal

Response samples

application/json
Copy
Expand all Collapse all
{
  • "token": "string"
}

GetOrganizationAppointments

Get paginated personal appointments

path Parameters
organization
required
int64

id of an organization

query Parameters
limit
int64

max. amount of entries in list

offset
int64

amount of entries to skip

Responses

200

Paginated appointments for this user

500

database error

get /appointments/{organization}
https://app.groupalarm.com/api/v1/appointments/{organization}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "appointments":
    [
    ],
  • "totalAppointments": 0
}