calendar/events/getAll

Get a list of all events between two dates. All dates are returned in UTC time.

POST https://api.elvanto.com/v1/calendar/events/getAll.{json|xml|php}

Parameters

Name Type Description
page integer The results page to retrieve. Default: 1
page_size integer The number of records to retrieve per results page. Default: 1000
start Required date The date to start retrieving events from. Needs to be a valid date field. E.g: 2016-12-30
end Required date The date to stop retrieving events. Needs to be a valid date field. E.g: 2016-12-30
calendar string|array The ID of the calendar(s) you would like to retrieve events from. To retrieve services, use "services" as the calendar.
fields array Optional fields you would like to retrieve for each event. More information on calendar events fields.
Expected request JSON HTTP POST
{
    "page": 1,
    "page_size": 100,
    "start": "2016-12-01",
    "end": "2016-12-31",
    "fields": [
        "locations"
    ]
}
Expected response JSON XML PHP
{
    "generated_in": "0.018",
    "status": "ok",
    "events": {
        "on_this_page": 28,
        "page": 1,
        "per_page": 100,
        "total": 28,
        "event": [
            {
                "id": "52139416-ff4d-11e2-847a-46e7b7dc2836",
                "calendar_id": "847a9416-ff4d-2836-5213-46e7b7dc11e2",
                "interval": "",
                "name": "Church Picnic",
                "description": "Come down and enjoy a fun family picnic!",
                "admin_notes": "ADMINS ONLY: Please ensure that we have all the BBQs cleaned by the end of the picnic!",
                "where": "The Park",
                "start_date": "2016-06-03 04:00:00",
                "end_date": "2016-06-03 05:00:00",
                "all_day": 1,
                "url": "http://yourchurch.elvanto.com/event/5213a546-ff4d-11e2-847a-46e7b7dc2836",
                "color": "#000000",
                "locations": {
                    "location": [
                        {
                            "id": "8a631195-8914-4136-858c-f160885ab60d",
                            "name": "Central Campus"
                        },
                        {
                            "id": "9f3aec97-3d61-471d-ab50-5f28070d970d",
                            "name": "North Campus"
                        }
                    ]
                }
            },
            {
                "id": "5213bc7a-ff4d-11e2-847a-46e7b7dc2836",
                "calendar_id": "847a9416-ff4d-2836-5213-46e7b7dc11e2",
                "interval": "",
                "name": "Leaders Meeting",
                "description": "",
                "admin_notes": "ADMINS ONLY: Meeting Minutes from last meeting needs to be printed",
                "where": "Church Building",
                "start_date": "2016-06-10 04:00:00",
                "end_date": "2016-06-10 05:00:00",
                "all_day": 0,
                "url": "http://yourchurch.elvanto.com/cevent/5213ce04-ff4d-11e2-847a-46e7b7dc2836",
                "color": "#f7d14a",
                "locations": {
                    "location": [
                        {
                            "id": "8a631195-8914-4136-858c-f160885ab60d",
                            "name": "Central Campus"
                        }
                    ]
                }
            }
        ]
    }
}
Error responses:

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: Invalid page number The page number you have provided is invalid.
  • 250: Invalid page size The page size must be between 10 and 1000.
  • 250: Invalid Calendar ID The ID of the calendar you used does not exist.
  • 404: No events found No events could be found between the dates you specified.