Get Appointment
This request returns extended information of an appointment.
The object ID (OID) of the appointment is a part of the resource URL. This OID is typically retrieved by a calendar get request.
Resource
GET /appointments/<OID>
Where OID is the object ID of the appointment (see comments above).
Parameters
None
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
Request
GET https://xelion.nl/api/v1/master/appointments/1627410
Response when appointment has a recurrence
{
"object": {
"calendars": [],
"subject": "SLapen",
"starttime": "2017-03-13 10:10:00",
"endtime": "2017-03-13 10:20:00",
"allStartDay": false,
"allEndDay": false,
"internal": true,
"userStatus": "at_appointment",
"participants": [
{
"commonName": "Haas Henk",
"oid": "1626686",
"objectType": "Person"
}
],
"recurrenceTerminationType": "recurrenceCount",
"recurrenceTerminationDate": "",
"firstRecurrenceDate": "2017-03-19 23:00:00",
"lastRecurrenceDate": "2017-04-23 22:00:00",
"recurrenceCount": 6,
"recurrenceType": "weekly",
"recurrenceInterval": 1,
"isRecurrence": true,
"monday": true,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"saturday": false,
"sunday": false,
"permissions": "ReadWriteRemove",
"commonName": "Afspraak",
"comment": {
"content": "",
"oid": "1758518",
"objectType": "Comment"
},
"oid": "1758518",
"objectType": "XCCAppointment"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/api/v1/master/calendars/1758518",
"method": "GET"
}
]
}Response when appointment has no recurrence
{
"object": {
"calendars": [],
"subject": "Taart eten",
"starttime": "2017-03-24 13:43:00",
"endtime": "2017-03-24 16:00:00",
"allStartDay": false,
"allEndDay": false,
"internal": true,
"userStatus": "unavailable",
"participants": [
{
"commonName": "Haas Henk",
"oid": "1626686",
"objectType": "Person"
}
],
"isRecurrence": false,
"permissions": "ReadWriteRemove",
"commonName": "",
"comment": {
"content": "",
"oid": "1758831",
"objectType": "Comment"
},
"oid": "1758831",
"objectType": "XCCAppointment"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/api/v1/master/calendars/1758831",
"method": "GET"
}
]
}