Get persons in a family Multipass for an organization
GET api/V3/{language}/org/{orgIdentifier}/multipass/{id}/accounts
?showMedicalInfo={showMedicalInfo}
&showArchived={showArchived}
&page={page}
&perPage={perPage}
You can get the multipass id from /org/{orgIdentifier}/multipass. Returns a list of family accounts ordered by id, with the option to show cancelled multipasses, and whether to show the medical information (if any) for each person
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) |
MultiPass id |
Required |
| showMedicalInfo (boolean) |
Option to show the persons' medical information. Default value is False |
Optional |
| showArchived (boolean) |
Option to also show archived items. 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 | ||
|---|---|---|
| PurchasedDate (date) |
Date when resource was purchased. Format is 9999-12-31 |
|
| EffectiveDate (date) |
Date when resource is effective. Format is 9999-12-31 |
|
| ExpirationDate (date) |
Date when resource expires. Format is 9999-12-31 |
|
| TokensLeft (integer) | ||
| HasUnlimitedTokens (boolean) | ||
| Id (integer) |
Resource id |
|
| Owners () |
Account owners |
|
| Members () |
Account members |
|
| Corporate (CorporateApiModelV3) |
Corporate account details |
|
| AccountMemberships () | ||