/attendees

Returns the event attendance tracking information for a single or multiple users, across individual or multiple events, ordered by Attendance ID.

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 the list of attendees will be returned

INT

organizationId

The ID of the specific organization for which all sponsored event attendance information will be returned

INT

attendanceId

The attendance ID of a specific user from an event’s attendance list that will be returned in the response

INT

userId

The user ID of the specific user whose event attendance information will be returned in the response

INT

username

The username of the specific user whose event attendance information will be returned in the response

STRING

EventAttendanceStatus

The attendance tracking status that users must have in order to be included in the response

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

Note: Accepted values include “attended”, “absent”, “excused”, “na”, and “any”. The value “any” will be used by default if the parameter is not explicitly set.

STRING

status

The account status value any user must have in order to be included in the response

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

Note: Accepted values include “active” (includes only confirmed users), “archived” (includes confirmed and unconfirmed users), or “all” (includes confirmed and unconfirmed users). The value “active” will be used by default if the parameter is not explicitly set.

STRING

includeReflections

The toggle for indicating whether user self-reflections should be returned in the response

Including this parameter in your call will adjust the response to either include or leave out self-reflections, where the value “true” is used to have self-reflections included and the value “false” is used for leaving them out. 

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

BOOL

includeUnrecognizedUsers

The toggle for indicating whether only recognized users (i.e., those who have been specifically identified by campus email address or card ID number) or also unrecognized users (i.e., those who have not been specifically identified by a campus email address or card ID but who were tracked as attended via one of those two values) should be returned in the response.

Including this parameter with the value “true” in your call will adjust the response to only include unrecognized users in the attendance list. Including this parameter with the value “false” in your call will adjust the response to include only recognized users in the attendance list. 

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

STRING

startDate

A date filter based on the start date of a roster membership

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 a roster membership

Including this parameter in your call will limit the response to only include events with start 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 attendee

Sample Call:

https://yoursite/api/attendees/20542 (shown below) or https://yoursite/api/attendees?attendanceId=20542 (response structure same as calls for multiple or all attendees)

Sample Response:

 

Example: Calling for all attendees from all events in the system or all attendees from a single event

Sample Call:

https://yoursite/api/attendees or https://yoursite/api/attendees?eventId=768 (shown below)

Sample Response:

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

Contact Us