Get all Multipasses for an organization
GET api/V3/{language}/org/{orgIdentifier}/multipass
?page={page}
&perPage={perPage}
&showArchived={showArchived}
Returns all the multipasses that exist for this org.
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 |
| 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 |
| showArchived (boolean) |
Option to also show archived items. Default value is False |
Optional |
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 |
|
| ActivityIds () | ||
| PrivateLessonIds () | ||
| Price (decimal number) |
Price of activity |
|
| Passes (integer) | ||
| HasUnlimitedPasses (boolean) | ||
| IsFamilyPass (boolean) | ||
| Status (string) |
Object containing the possible status values (case-insensitive). |
|
| IsArchived (boolean) |
True if resource is archived |
|
| EffectiveDate (date) |
Date when resource is effective. Format is 9999-12-31 |
|
| ExpirationDate (date) |
Date when resource expires. Format is 9999-12-31 |
|
| StartTrigger (string) | ||
| EndTrigger (string) | ||
| ValidityPeriod (MultiPassValidityApiModel) | ||
| MembershipRequired (RequiresMembershipApiModel) | ||
| NumberSold (integer) | ||