Get an activity's occurrences
GET api/V3/{language}/activities/{id}/occurrences
?showEdited={showEdited}
&start={start}
&end={end}
&page={page}
&perPage={perPage}
Returns a list of activity occurrences (events), with the option to define a start and end date and to show those that have been edited
Request Information
URI Parameters
| PARAMETERS | ||
|---|---|---|
| language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
| id (integer) |
Activity id |
Required |
| showEdited (boolean) |
Option to show items that have been modified. Default value is False |
Optional |
| 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 |
| page (integer) |
Result page number that appears first. Default value is 1 |
Optional |
| perPage (integer) |
Number of results per page. Default value is 200 |
Optional |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| HasDropInEnabled (boolean) |
True for drop-ins |
|
| DropInMaxAttendance (integer) | ||
| DropInSpotsReserved (integer) | ||
| DropInSpotsRemaining (integer) | ||
| ActivityId (integer) |
Id of the activity |
|
| Start (date) |
Inclusive start limit. Format is 9999-12-31 |
|
| End (date) |
Inclusive end limit. Format is 9999-12-31 |
|
| State (ActivitySegmentState) |
For an activity, object containing the values Normal, Skipped, Moved, Cancelled, Archived and Replaced |
|
| Id (integer) |
Resource id |
|
| Location (LocationSummaryApiModelV3) |
Object containing location id and name |
|
| Staff () |
Object containing staff id, first name, last name and state |
|