Page tree

Link API is now deprecated

As of March 2017, the Access ACS Link API is deprecated. 

The REST API replaces our Link API and offers more endpoints and features. Like the Link API, it matches the security credentials turned on for each unique user in the data. 

What does this mean for me?

First, you'll want to build any new applications on REST API. Second, update all of your existing applications to use the REST API as soon as possible.

Link API will be turned off in April of 2018, giving you time to complete your transition.

About the Link API

The other ACS API's give you access to all of your data, and it is up to you to parse the data to provide the proper view. The Link API includes the security credentials in front of the data. The view of the data matches the security bits that have been turned on for that unique user within the product.

For events, only published events display to the member. For staff users, all events display. The directory information reflects the published information in Access ACS for members, but displays in its entirety for staff.

The format for accessing this data is also different. At the core of Access ACS is your data: people, groups, events, and more. The Link API presents a simple, secure "link" directly to your data. Think of this key data - people, groups, events - most objects in Access ACS have a unique ID. You can access the properties or details of an object by requesting them via URL. For example, James Aaron has an id of 72 , that means you can fetch the object details by entering the id of 72 in the URL.

Authorization

The Link API requires authorization to retrieve private information. Data will be returned based on the provided user name, password, and site number combination.

Methods

E-mail Login Details

E-mail Login Details URL
 https://api.accessacs.com/account/signin 

Useful Information

This is not a traditional REST call but uses a HTTP post. The email address and password used for Access ACS is provided. One email address in Access ACS can be related to multiple site numbers (accounts) and/or user names. This call returns a list of users and site numbers associated with that email address. All subsequent calls will use the user name and password combination with the site number.

Search Individuals

Search Individuals URL
 https://api.accessacs.com/[SiteNumber]/individuals 

This gives you directory search type functionality. All individuals could be returned, or search data can be provided in a query string.

Parameters:

  • int siteNumber (url)
  • string searchText (required)
  • int firstResult (optional default =0)
  • int maxResults (optional default = 50)

Example

Data returned:

  • IndvId, Primary Family ID, Last Name, First Name, Middle Name, Goes by Name, Suffix, Title, PictureURL, and the Unlisted flag

Get Individual Details

Get Individual Details URL
 https://api.accessacs.com/[SiteNumber]/individual/[IndividualID]

By passing in an IndividualID that can be obtained through searching for individuals, the profile details can be returned.

Parameters:

  • int siteNumber (url)
  • int id (url)

Data Returned:

  • IndvId, Primary Family ID, Last Name, First Name, Middle Name, Goes by Name, Suffix, Title, Picture URL, Family Picture URL
  • Addresses (Address ID, Type, Shared Flag, Country, Company, Address, Address2, City, State, Zipcode, Latitude, Longitude)
  • Emails (Email ID, Email Type, Preferred Flag, Email address, Listed flag)
  • Phones (Phone ID, Active flag, Phone Type ID, Phone Type, Shared Flag, Phone Number, Area Code, Extension, Listed, Address Phone Flag)
  • Family (Family ID, Family Position)
  • Family Members (Individual ID, Primary Family ID, Last Name, First Name, Middle Name, Goes By Name, Suffix, Title, Picture URL, Unlisted)

Search Events

Search Events URL
  https://api.accessacs.com/[SiteNumber]/events

This API can query events based on a start date and stop date.

Example

 https://api.accessacs.com/106217/events?startdate=01/01/2011&stopdate=08/01/2011 

Parameters:

  • int siteNumber (url)
  • dateString startDate (required)
  • dateString stopDate (required)
  • int firstResult (optional default =0)
  • int maxResults (optional default = 50)

Data returned:

  • Event ID, Description, Event Type ID, Event Type, Event Name, Note, Location ID, Location, Start Date, Stop Date, Is Published Flag

Get Event Details

Get Event Details URL
 https://api.accessacs.com/[SiteNumber]/event/[EventID] 

Based on the EventID, obtained via Search Events, the details of the event are returned.

Parameters:

  • int siteNumber (url)
  • int id (url)

Data returned:

  • Site ID, Event ID, Parent ID, Event Type ID, Event Type, Calendar ID, Calendar, Event Nam,e Description, Status, Setup, Teardown, Is Published flag, Allow Registration, Is Booked, Note, Location ID, Location, Start Date, Stop Date