Get a single appointment
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Get a single appointment
For retrieving an appointment of an applicant by the appointment-ID use the /appointments/{appointmentId} endpoint, with the desired appointments ID.
By sending the following GET-request, one can obtain the requested list containing all appointments of a user:
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/appointments/{appointmentId}" |
with TOKEN being the user access token of the user in question. It is used to determine the validity of this request.
Path parameters
Name | Description | Data Type |
---|---|---|
appointmentId | The ID of the desired appointment. | String |
Query parameters
– none –
Response values
Upon | Returned value | Description |
---|---|---|
success | JSON-encoded AppointmentData-object | See on the according reference page. |
failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
authorization error | 401 / 403 | See here for details. |
Example return value
1 2 3 4 5 6 7 8 9 10 |
{ "uid": "df3b10d160604c00bb3beff323e660d7", "startDate": 1381582800000, "endDate": 1381586400000, "location": null, "description": "Einladung zum 1. Gespräch", "title": "Einladung zum 1. Gespräch", "status": "CREATED", "timeZoneId": "Europe/Berlin" } |