/events

Returns event information for a single or multiple events, ordered by the event start date and time.

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

INT

pageSize

The number of items to include in the page of results

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”.

INT

eventID

The ID of the specific event for which information will be returned

INT

organizationId

The ID of the specific organization for which information on all sponsored events will be returned 

INT

locationId

The ID of the location/space for which information on all hosted events will be returned

INT

externalId

The ID from an external system of the location/space for which information on all hosted events will be returned

Note: This value is exclusively used for locations/spaces that were imported from EMS. This ID should not be confused with usernames/user ID that are sometimes referred to as "External IDs"

INT

currentEventsOnly

The toggle for indicating whether only on-going and future events, or also past events, should be returned in the response

Including this parameter with the value “true” in your call will adjust the response to only include today’s and future events. Including this parameter with the value “false” in your call will adjust the response to include today’s, future, and past events.

Note: The value “false” will be used by default if the parameter is not explicitly set.

BOOL

 

status

The status that events must have in order to be included in the response

Including this parameter in your call will limit the response to only include events with the status value specified.

Note: Accepted values include “approved” and “canceled”.

STRING

category

The category that events must have in order to be included in the response

Including this parameter in your call will limit the response to only include events with the category value specified.

Note: Category names are custom values set by each institution. Log in to your system and check the Event Administration area to see your category name values. Events may have any number of categories assigned to them, or none at all.

STRING

type

The type that events must have in order to be included in the response

Including this parameter in your call will limit the response to only include events with the type value specified. 

Note: Accepted values include “public”, “campus only”, “organization only”, and “private”.

STRING

name

A string that events must have in their name in order to be included in the response

Including this parameter in your call will limit the response ton only include events with a name that matches or contains all of the value specified.

STRING

startDate

A date filter based on the start date of the Event

Including this parameter in your call will limit the response to only include events with start dates that are on or after the specified date. 

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time). 

LONG

endDate

A date filter based on the end date of the Event

 Including this parameter in your call will limit the response to only include events with end dates that are on or before the specified date.

 Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time).

LONG

Example: Calling for a specific event

Sample Call:

https://yoursite/api/events/820 (shown below) or https://yoursite/api/events?eventId=820 (response structure same as calls for multiple or all events)

Sample Response:

  

Example: Calling for all or multiple events

Sample Call:

https://yoursite/api/events

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Contact Us