Get Calendar from Xcccalendar oid


This request returns a list of appointments that are on the specified calendar

Resource

GET /calendars/<OID>[?parameters]

Where OID is the object ID of the desired user or xccCalendar object.

Parameters

Name Type Description

after

[Date]

Select appointments which start on this date

before

[Date]

Select appointments which end on this date

limit

Integer

The maximum number of objects to return. Default: 15.

  • No before & after paramters results in returning a list of appointments for today.

Payload

None

Context

Authorization

User

Errors

Example

Request
GET https://xelion.nl/api/v1/master/calendars/1557367?after=2016-11-10&before=2016-12-09
Response
{
    "data": [
        {
            "object": {
                "subject": "SLapen",
                "starttime": "2017-03-20 10:10:00",
                "endtime": "2017-03-20 10:20:00",
                "allStartDay": false,
                "allEndDay": false,
                "internal": true,
                "isAppointmentOf": {
                    "commonName": "Haas Henk",
                    "oid": "1626686",
                    "objectType": "Person"
                },
                "isRecurrence": true,
                "commonName": "SLapen: 11:10 - 11:20, 13 mrt 2017",
                "oid": "1758518",
                "objectType": "XCCAppointment"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/calendars/1758518",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "subject": "Taart eten",
                "starttime": "2017-03-24 13:43:00",
                "endtime": "2017-03-24 16:00:00",
                "allStartDay": false,
                "allEndDay": false,
                "internal": true,
                "isRecurrence": false,
                "commonName": "Taart eten: 14:43 - 17:00, 24 mrt 2017",
                "oid": "1758831",
                "objectType": "XCCAppointment"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/calendars/1758831",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://localhost:8080/api/v1/master/calendars/1626686",
                "method": "GET"
            }
        ]
    }
}