GET /api/participants/:event_id

Description

Returns list of Participant objects for event.

Parameters

event_id

Int. ID for the event to get participants for.

waitlist

Int. Optional. 1/0. If 1, will return only participants on wait list. If 0, will return only participants not on waitlist. If unset, will return both.

passed

Int. Optional. 1/0. If 1, will return only participants who have passed the course. If 0 will return only participants who did not pass the course. If unset, will return both.

met

Int. Optional. 1/0. If 1, will return only participants who met for the course. If 0 will return only participants who did not meet for the course. If unset, will return both.

organisation_id

Int. Optional. ID of organisation, will restrict participants to only those who are employed here.

recursive

Int. Optional. 1/0. If set, organisation_id will be user recursively, looking down the organisation tree branch.

view

String. Optional. "full"/"simple". What view to use.

start

DEPRECATED. Will be removed in future version. Use offset in stead.

limit

Int. Optional. Default: 20. Maximum: 100. Limit the size of the result set.

offset

Int. Optional. Default: 0. Offset the result set, starting at this index. For batching/paging.

fields

String. Optional. See Field customization.

Return

Array of Participant objects.

Security

Superuser, organisation’s manager if organisation_id is given

GET /api/participants/:event_id/:user_name

Description

Returns single Participant for event.

Parameters

event_id

Int. ID for the event to get participant for.

user_name

String. Optional. User name for user.

view

String. Optional. "full"/"simple". What view to use.

fields

String. Optional. See Field customization.

Return

Single Participant objects.

Security

Superuser, person's manager, self