event_id
Unique ID of the event object.
id
Alias for "event_id".
title
Title of the event
startdate
Start date and time for the event.
enddate
End date and time for the event.
publishdate
Date from when event is available for sign on for normal users. If Null, event is not published. Note that super users are able to override this, and can always sign persons on to events, regardless of publish date, sign on deadline, etc.
location
Name of the location where the event is held.
cost
Cost/price for course
joinable
Whether or not this event is available for sign on for the logged in user.
short_description
Short description of the event.
description
Full description of the event.
sign_on_deadline
The deadline date for signing up for the event.
sign_off_deadline
The deadline date for signing off for the event.
haschildren
Flag indicating whether this event has children modules.
children
Array with children Event objects.
organisations
List of Organisation objects this event is restricted to.
min_age
Minimum age required for participant.
max_age
Maximum age required for participants.
max_participants
Maximum number of participants allowed for this event.
participants_count
Number of participants currently signed on to event.
available_count
Number of available places for event.
attributes
Array of CompetenceAttribute registered for the event.
instructors
Array of Persons registered as instructors for the event.
host_name
Title of the host organisation object.
host
Simple representation of Organisation object set as host for the event.
external_sign_on
Is sign on through API allowed or not.
payment
Is payment (online or invoice) set up for this event.
payment_types
Which payment types are allowed. Array of strings.
durations
Array of Duration objects.
certificates_url
Relative URL to get certificates for participants. Note that only participants who have passed the event will be included, and that only finished events are eligible for certificates.
- If logged in user is superuser, admin or instructor for the course, ALL passed participants will be included.
- If logged in user is manager/employeemanager, all participants belonging to user's organisations (recursively) will be included.
- If GET parameter "pids" is added to URL (multiple allowed: pids=11&pids=12&...), only participants with these person IDs will be included (given that user is allowed to).
- If GET parameter "oid" is added to URL (only one: oid=10), it overrides "pids", and includes all participants from that organisation (recursively).
- If user is trying to do something he is not allowed to, the resource will respond with an "Unauthorized" response code (and a login form).
user_file_upload_date_limit
Date and time limit for end user file upload
user_file_upload_allowed
True if end user should be allowed to upload files to given course event, else False
travelinformations
Array of TravelInformation objects associated with event.