Get an activity by id
GET PublicApi/{rewriteUrl}/{language}/Activities/{id}
You can get the activity id from /Events.
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 |
| id (integer) |
Activity id |
Required |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| Id (integer) |
Resource id |
|
| Name (string) |
Resource name |
|
| Description (string) |
Description of the activity that will be visible to your customers in your store |
|
| ResponsibleName (string) | ||
| 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 |
|
| ExtraInformation (string) | ||
| Url (string) |
Url of the resource |
|
| IsTeam (boolean) | ||
| IsTeamRegistration (boolean) | ||
| Fee (decimal number) | ||
| Start (date) |
Inclusive start limit. Format is 9999-12-31 |
|
| End (date) |
Inclusive end limit. Format is 9999-12-31 |
|
| LegacyLocation (string) | ||
| HashId (string) | ||
| Price (decimal number) |
Price of activity |
|
| DropInPrice (decimal number) |
Price of drop-in activity |
|
| Schedule () | ||
| Age (ActivityAge) |
Object containing minimum and maximum ages, and the option to specify age in months |
|
| TaxCredit (ActivityTaxCredit) | ||
| 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 |
|
| RegistrationRevenue (decimal number) | ||
| SessionRevenue (decimal number) | ||
| DropinRevenue (decimal number) | ||
| MerchandiseRevenue (decimal number) | ||
| ShortScheduleString (string) | ||
| HasSessionEnabled (boolean) |
True for subscriptions |
|
| HasDropInEnabled (boolean) |
True for drop-ins |
|
| AgeSummary (string) |
Minimum-maximum age span, in format '7-77' |
|
| OrganizationId (integer) |
Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters |
|
| SubCategoryName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| ProgramId (integer) |
Id of the program |
|
| CategoryId (integer) |
Id of the category |
|
| SubCategoryId (integer) |
Id of the subcategory |
|
| SubCategoryPosition (integer) | ||
| Status (StateType) |
Object containing the possible status values (case-insensitive). For an activity, possible values are Normal, Hidden and Cancelled. |
|
| CategoryName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| ProgramName (string) |
Part of the hierarchy Program > Category > Subcategory > Activity |
|
| PictureUrl (string) |
Url of the resource picture |
|
| TagIds () | ||