Get activity events (occurrences)
GET PublicApi/{rewriteUrl}/{language}/Events
?start={start}
&end={end}
&programId={programId}
&showHidden={showHidden}
&onlyTeam={onlyTeam}
&showImages={showImages}
The result can include different states of occurrences, namely: Normal: is scheduled Skipped: the specific occurrence was skipped due to a conflict with a holiday or manually by an administrator Cancelled: the activity was cancelled, therefore this occurrence too Archived: the activity was cancelled, but there was registration linked to this occurrence. The URL is a link to the activity's page in the store. This can be useful if you want to display the occurrences in a calendar and refer to the registration page of the activity.
Request Information
URI Parameters
| PARAMETERS | ||
|---|---|---|
| rewriteUrl (string) |
Unique, url-friendly organization token. Part of base url |
Required |
| language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
| start (date) |
Inclusive start limit of a date range filter. Format is YYYY-MM-DD. When both start and end are omitted, returns events for today |
Optional |
| end (date) |
Inclusive end limit of a date range filter. Format is YYYY-MM-DD. If end is omitted, retrieves only for one day specified by start |
Optional |
| programId (integer) |
Id of the program in which the event is. Default value is null |
Optional |
| showHidden (boolean) |
Option to return hidden items. Default value is False |
Optional |
| onlyTeam (boolean) |
Option to return only team activities. Default value is False |
Optional |
| showImages (boolean) |
Default value is True |
Optional |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| id (integer) | ||
| start (date) | ||
| end (date) | ||
| allDay (boolean) | ||
| title (string) | ||
| url (string) | ||
| state (ActivitySegmentState) | ||
| Type (string) | ||
| Fee (decimal number) | ||
| AttendanceString (string) | ||
| HasPlaceLeft (boolean) | ||
| CanRegister (boolean) | ||
| CanUnregister (boolean) | ||
| HasPassed (boolean) | ||
| HasDropIns (boolean) | ||
| PictureUrl (string) |
Url of the resource picture |
|
| ExtraInformation (string) | ||
| IsHidden (boolean) | ||
| Day (string) | ||
| IsHome (boolean) | ||
| IsTeamRegistration (boolean) | ||
| IsTeam (boolean) | ||
| MaxAttendance (integer) |
Maximum number of spots |
|
| Description (string) |
Description of the activity that will be visible to your customers in your store |
|
| CalendarSeriesId (integer) | ||
| Price (decimal number) |
Price of activity |
|
| ActivityId (integer) |
Id of the activity |
|
| ActivityName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| SubCategoryId (integer) |
Id of the subcategory |
|
| SubCategoryName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| CategoryId (integer) |
Id of the category |
|
| CategoryName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| ProgramId (integer) |
Id of the program |
|
| ProgramName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| Location (string) |
Object containing location id and name |
|
| HashId (string) | ||
| ExtraPoints (string) | ||
| Facilities () | ||
| Staff () |
Object containing staff id, first name, last name and state |
|
| resourceId (integer) | ||
| Tags () |
Object containing the id and name of a tag. Tags are used to group and retrieve activities, such as 'morning' or 'George Smith' |
|
| AttendanceSummary (ActivitySegmentEventAttendanceSummary) | ||