GET /api/personevents

Description

Returns list of events user is signed on to.

Parameters

user_name

String. Optional. User name for user. Will return for logged in user if not present.

start

Int. Optional. Index to start at.

limit

Int. Optional. Max length of result set.

mode

String. Optional. ”future”/”finished”/”all”.  Controls if we are to get future or finished events, or both. Default: ”future”

waitlist

Int. Optional. 0/1. Return events for which person is on waitlist or not. Default 0.

organisation_id

Int. Optional. Return personevents for persons belonging to organiasation unit. Will override user_name parameter.

Return

Array of PersonEvent objects.

Security

Superuser, manager, self

GET /api/personevents/[event_id]

Description

Get detailed view of event for person. Will return empty list if person is not signed on to event.

Return

Array of one PersonEvent object.

Security

Superuser, manager, self

POST /api/personevents/[event_id]

Description

Signs person on to course event.

Parameters

user_name

String. Optional. Username for user to be signed on.

order_id

Int. Optional. ID of order to add this sign on to. Only valid if order system is enabled.

order_reference

String. Optional. Order reference for new order that is created. Only valid if order system is enabled. Ignored if parameter order_id is given.

Return

Array of one PersonEvent object.

Security

Superuser, manager, self

PUT /api/personevents/[event_id]

Description

Signs person off course event. Or otherwise alters the sign on data (not specified or implemented yet).

Parameters

user_name

String. Username for user.

action

String. ”off”/”update”. Action to take. ”off” signs person off event.

Return

Array of one PersonEvent object.

Security

Superuser, manager, self