Get a program's activities for an organization
GET api/V3/{language}/org/{orgIdentifier}/programs/{id}/activities
?showHidden={showHidden}
&showCancelled={showCancelled}
&showOccurrences={showOccurrences}
&showTaxes={showTaxes}
&page={page}
&perPage={perPage}
You can get the program id from org/{orgIdentifier}/programs. Returns a list of activities ordered by id, with the option to show hidden and cancelled activities
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) |
Program id |
Required |
| showHidden (boolean) |
Option to return hidden items. Default value is False |
Optional |
| showCancelled (boolean) |
Option to also return cancelled items. Default value is False |
Optional |
| showOccurrences (boolean) |
Option to show the full list of activity occurrences. Default value is False |
Optional |
| showTaxes (boolean) |
Default value is False |
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 | ||
|---|---|---|
| Tags () |
Object containing the id and name of a tag. Tags are used to group and retrieve activities, such as 'morning' or 'George Smith' |
|
| Description (string) |
Description of the activity that will be visible to your customers in your store |
|
| Prerequisite (string) |
Specific prerequisites for an activity. This does not prevent the clients from registering, only informs them |
|
| Note (string) |
Additional important information, such as what to bring |
|
| ThirdPartyUrl (string) |
For registrations happening with a third party instead of Amilia |
|
| AdditionalInformation (string) |
Additional important information, such as what to bring |
|
| ResponsibleName (string) | ||
| Price (decimal number) |
Price of activity |
|
| DropInPrice (decimal number) |
Price of drop-in activity |
|
| DisplayOrder (integer) | ||
| Age (ActivityAgeApiModelV3) |
Object containing minimum and maximum ages, and the option to specify age in months |
|
| MaxAttendance (integer) |
Maximum number of spots |
|
| SpotsRemaining (integer) |
Number of spots still available in an activity |
|
| SpotsReserved (integer) |
Number of reserved spots for an activity |
|
| NumberOfOccurrences (integer) |
Number of occurrences the activity has |
|
| StartDate (date) |
Inclusive start limit. Format is 9999-12-31 |
|
| EndDate (date) |
Inclusive end limit. Format is 9999-12-31 |
|
| ScheduleSummary (string) |
Description such as 'Fridays 16h-17h, 2 May to 27 August', as opposed to a full list of occurrences |
|
| HasSessionEnabled (boolean) |
True for subscriptions |
|
| HasDropInEnabled (boolean) |
True for drop-ins |
|
| AgeSummary (string) |
Minimum-maximum age span, in format '7-77' |
|
| Keywords () |
Object containing the id and name of keywords, which are specific types of activities, such as 'soccer' or 'yoga' |
|
| Groups () |
In an activity, object containing the groups and their details |
|
| OrganizationId (integer) |
Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters |
|
| Occurrences () | ||
| RegistrationPeriods () | ||
| Taxes (ApplicableTaxesModelV3) | ||
| LocationLabel (string) | ||
| SecretUrl (string) | ||
| PictureUrl (string) |
Url of the resource picture |
|
| Id (integer) |
Resource id |
|
| Name (string) |
Resource name |
|
| ProgramId (integer) |
Id of the program |
|
| ProgramName (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 |
|
| SubCategoryId (integer) |
Id of the subcategory |
|
| SubCategoryName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| Url (string) |
Url of the resource |
|
| Status (StateType) |
Object containing the possible status values (case-insensitive). For an activity, possible values are Normal, Hidden and Cancelled. |
|