Get persons in a family membership for an organization
GET api/V3/{language}/org/{orgIdentifier}/memberships/{id}/accounts
?status={status}
&showMedicalInfo={showMedicalInfo}
&from={from}
&to={to}
&page={page}
&perPage={perPage}
You can get the membership id from /org/{orgIdentifier}/memberships. Returns a list of family accounts ordered by id, with the option to specify the membership's status, start and end dates 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) |
Membership id |
Required |
| status (string) |
Possible values are 'Active', 'Inactive', 'Expired', and 'All'. These values are case-insensitive. Default value is active |
Optional |
| showMedicalInfo (boolean) |
Option to show the persons' medical information. 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 | ||
|---|---|---|
| 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 |
|
| Id (integer) |
Resource id |
|
| Owners () |
Account owners |
|
| Members () |
Account members |
|
| Corporate (CorporateApiModelV3) |
Corporate account details |
|
| AccountMemberships () | ||