Page tree

GET

/:site_number/events?&startdate=:start_date&stopdate=:stop_date&calendarids=

:calendar_id

Returns a list of events for the current month (unless a specific date range is entered) based on a specific calendar.

Example

https://secure.accessacs.com/api_accessacs_mobile/v2/12345/events?&startdate=08/01/2015&stopdate=08/31/2015&pageIndex=0&pageSize=50

&calendarids=6ce6d1ff-7532-4a38-876a-94e75cc43cde

Notes

pageIndex and pageSize are not required for the API to work properly. These fields let you limit the number of records returned at one time and when you begin pulling information. If you do not enter this information, the index default is 0 and the size default is 50. 

For example, suppose you're looking for all the individuals with the first name John. 300 records match your criteria. If you leave the defaults, the first 50 matches display. If you change the pageIndex to 2, the next 50 matches are returned.

Use the MM/DD/YYYY format when entering dates.

Required Permissions

The user must fall into one of the categories below:

  • System Administration

  • A user with the following rights:

    • Rights to view at least one Calendar

    • All Rights to all Calendars

You will only see the events on calendars you have view rights to.

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

username: "jadams"

password: "password231"

URL Parameters

site_number – The site number to gather data for.

start_date – The date to start pulling events. (Optional)

stop_date – The date to stop pulling events. (Optional)

calendar_id – The calendar the events are pulled from.  Values from the Facility Scheduler Get List of Calendars API.  


Return Data

{
  "Page": [
    {
      "Description": null,
      "EventDateId": "0c4a883e-5ad1-4ef8-8b8e-a355009af705",
      "EventId": "0a5d8e2a-3a78-4c80-9c00-a04b00f7cb20",
      "EventName": "Chancel Choir Rehearsal",
      "EventType": null,
      "EventTypeId": null,
      "IsPublished": true,
      "LocationId": "f88abfb0-9656-4284-b675-b89974d5a757",
      "Location": "Choir Rehearsal Hall",
      "StartDate": "2015-08-02 10:00:00.000",
      "StopDate": "2015-08-02 10:20:00.000",
      "Status": "Confirmed",
      "CalendarName": "Choir",
      "IsRecurringEvent": true,
      "CalendarId": "6ce6d1ff-7532-4a38-876a-94e75cc43cde",
      "AllowRegistration": false
    },
    {
      "Description": null,
      "EventDateId": "46e42e49-ea60-46dd-8556-a52f009bbc36",
      "EventId": "1cb8ef45-1deb-44c8-95d2-a37e0098eaab",
      "EventName": "Choir Practice",
      "EventType": null,
      "EventTypeId": null,
      "IsPublished": true,
      "LocationId": "f88abfb0-9656-4284-b675-b89974d5a757",
      "Location": "Choir Rehearsal Hall",
      "StartDate": "2015-08-05 16:00:00.000",
      "StopDate": "2015-08-05 17:30:00.000",
      "Status": "Confirmed",
      "CalendarName": "Choir",
      "IsRecurringEvent": true,
      "CalendarId": "6ce6d1ff-7532-4a38-876a-94e75cc43cde",
      "AllowRegistration": false
    },
    {
      "Description": null,
      "EventDateId": "349d4357-03c0-4998-a1a3-a355009af705",
      "EventId": "0a5d8e2a-3a78-4c80-9c00-a04b00f7cb20",
      "EventName": "Chancel Choir Rehearsal",
      "EventType": null,
      "EventTypeId": null,
      "IsPublished": true,
      "LocationId": "f88abfb0-9656-4284-b675-b89974d5a757",
      "Location": "Choir Rehearsal Hall",
      "StartDate": "2015-08-09 10:00:00.000",
      "StopDate": "2015-08-09 10:20:00.000",
      "Status": "Confirmed",
      "CalendarName": "Choir",
      "IsRecurringEvent": true,
      "CalendarId": "6ce6d1ff-7532-4a38-876a-94e75cc43cde",
      "AllowRegistration": false
    }
  ],
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 50
}

Notes

If you enter the calendar_id, only that calendar is pulled.  

You may pull more than one calendar by separating them by a comma.  For example, calendar_id=6ce6d1ff-7532-4a38-876a-94e75cc43cde,3e884a35-ee87-4212-ad84-681b489edc9f