Get an activity's occurrences for an organization
GET api/V3/{language}/org/{orgIdentifier}/activities/{id}/occurrences
?showEdited={showEdited}
&from={from}
&to={to}
&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 |
| orgIdentifier (string) |
Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'. |
Required |
| id (integer) |
Activity id |
Required |
| showEdited (boolean) |
Option to show items that have been modified. Default value is False |
Optional |
| from (date) |
Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null |
Optional |
| to (date) |
End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null |
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 |
|