Due to Hurricane Florence’s impact on South Carolina, ACS Technologies is suspending normal operations on Thursday, September 13th at 12:00 PM EDT - Friday, September 14th. All of our systems and backups are fully functional. Our support department will reopen as soon as it is safe to do so. Thank you for the privilege to serve your ministry. 

Page tree

Formal Definition and Version

Formal definition for Web service: wscea

Version: 2.0

Web Service Calls

These Web Service calls are for the Facility Scheduler calendar data.

Using the Facility Scheduler Web Services Events API

Before you begin using the Web Services Events API, make sure you have a read and completed all the steps on the Getting Started page.

Event Data and Local Calendar

Event data is stored in EST time. If your local calendar is not in EST time, you will need to adjust the data when working with it for accurate data to display.

Supported Operations

The following is a list of the supported operations. For a formal definition, please review the Service Description

  • GetBookedResources— Get booked resources.
    • An example call would be getBookedResources (token, 5/15/2010, 5/16/2010, -1, -1, *) where the "-1"s return all event types and all resource types. 
    • Another example would be getBookedResources (token, 5/15/2010, 5/16/2010, [ 88d0c33b-919b-4df4-bba2-88f87eb61bf0, 83d0c33b-919b-4df4-bba2-88f87eb61bf2], [81d0c33b-919b-4df4-bba2-88f87eb61bf4, 80d0c33b-919b-4df4-bba2-88f87eb61bf6], *) where it would filter on the guid arrays. These guids would be pulled from other web service calls and are passed as a string array, not a guid array.
    • For the last parameter, if you pass in an asterisk (*) then it will pull back all fields. If you pass in an array list of strings then it will limit the columns sent back to that list of values.
  • GetEventBookings— Get booked events.
    • The resourceIdList works the same way with the "-1" as getBookedResources where "-1" returns all.
    • The fieldList works the same way with an asterisk as getBookedResources where (*) returns all.
  • GetEventBookingNotes— Get booking note descriptions from resources that are booked for events.
    • Requires at least one quid for an eventResourceID
    • An example scenario is if you have set up notes for a particular event then call this after a call to getBookedResources.  It would be a way to “drill down” on data to see what additional information exists. (This may be that the air needs to be turned on early. Or a projector needs to be picked up ahead of time. Etc…)
  • GetEventCustomFields— Get event custom fields.
    • Requires a single event id for the parameter.
  • GetEventMediaNames— Get event media names.
    • Requires a single event id for the parameter.
  • GetEventNotes_Descriptions— Get event note descriptions.
    • Requires a single event id for the parameter.
  • getTagsbyEventID — Get a list of tags that are associated with an event.
  • getTagsbytagID — Get a list of events by a tagid.
  • getTagsList— Get the list of tags associated with your site.
    • An example scenario is to use this call to retrieve a list of different tags. Then call into getTagsbyTagID to pull down the corresponding events. Or call into getTagsbyEventID to retrieve the tags for that event and then call getTagsbyTagID to find similar events. Either way will work and the assumption is that you have “tagged” events so they can be pulled that way. (This is a good way to tag all “teenage” events. Or all “senior” events.)
  • getEventTypes— Get the event type values.
    • An example scenario is to use this call passing into it getBookedResources. (Realize however that you have to be using EventTypeIDs for this to work. This isn’t required). These event types might be birthday gatherings, mothers day out, Thursday night social, etc.
  • getResourceTypes— Returns a list of all resources regardless of what “type” they are.
    • An example scenario is to use this call to return all of the resources that have been set up and the corresponding guid. You could then take one of these guids and call getBookedResources to see what resources are being used for a certain date range. (ie, what dates is a room booked for, is the bus available, etc)
  • getResourcesByType - Returns resources under each type. The resourceid for locations (type 2) can be passed in to the function getEventsByDateRange as locationID. Pass in the string token and int typeID.
  • getEventsByDateRange - Returns all events during the date range by passing in the token, DateTime startdate, DateTime stopdate.
  • getCalendars - Returns a list of all published and unpublished calendars by passing in the token and boolean isPublished.
  • getCalendarEvents - Returns a list of all events for a certain date range for a certain calendar. CalendarID is the CalendarID from getCalendars. Parameters are string token, DateTime startdate, DateTime stopdate, string CalendarId.
  • getEventsByDateRangeFilteredByResourceTypeID - Returns all events filtered by a resourceType (ie, 1, 2, 3).  Parameters are string token, DateTime startdate, DateTime stopdate, int typeid.
  • getEventsByDateRangeFilteredByLocationID  - Returns all events for a certain date range for a certain location.  locationid is found as the resource id from getResourceByType when using a type of 2. Parameters are string token, DateTime startdate, DateTime stopdate, Guid locationId.
  • getEventImage - Pass in eventID to get the image url returned for the image (if one exists).
  • getEventDetail - Pass in eventId to get all of the detail about the specific event.
  • getModifiedEventsByDateRange - Filter events by start and stop date.

Additional Resources

  • AcsAPIfromclient.xlsx – Spreadsheet of calls and data details that are created by a client when working with the Event API. The field name, data type, max length, null availability, and comments are listed for each field in each call.