Get persons in a program for an organization
GET api/V3/{language}/org/{orgIdentifier}/programs/{id}/persons
?status={status}
&showSkills={showSkills}
&showRegistrations={showRegistrations}
&showMedicalInfo={showMedicalInfo}
&showCancelledRegistrations={showCancelledRegistrations}
&page={page}
&perPage={perPage}
You can get the program id from org/{orgIdentifier}/programs. Returns a list of persons ordered by id, with the option to show their skills, registrations and medical information
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 |
| status (PersonProgramStatusV3) |
Default value is Registered |
Optional |
| showSkills (boolean) |
Option to show relevant skills. Default value is False |
Optional |
| showRegistrations (boolean) |
Option to show the persons who registered. Default value is False |
Optional |
| showMedicalInfo (boolean) |
Option to show the persons' medical information. Default value is False |
Optional |
| showCancelledRegistrations (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 | ||
|---|---|---|
| OrganizationId (integer) |
Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters |
|
| AccountId (integer) |
Id of the account |
|
| AccountOwnerId (integer) |
Id of the account owner |
|
| AccountOwnerFirstName (string) |
First name of the account owner |
|
| AccountOwnerLastName (string) |
Last name of the account owner |
|
| AccountOwnerFullName (string) |
First and last name of the account owner with a space in between |
|
| AccountOwnerEmail (string) |
Email address of the account owner |
|
| AccountOwnerTelephoneMobile (string) | ||
| IsArchived (boolean) |
True if resource is archived |
|
| Contacts () |
Object containing the persons who are listed as contacts and their details |
|
| Skills () |
Object containing the skills and their details |
|
| Registrations () |
Object containing the registrations and their details |
|
| MedicalInformation (MedicalInformationApiModelV3) |
Object containing the medical information (allergies, sicknesses, reactions, medication) for a person |
|
| JoinDate (date) |
Date when the person joined |
|
| PictureUrl (string) |
Url of the resource picture |
|
| Memberships () | ||
| ExternalId (string) | ||
| Friend (string) | ||
| PickupPassword (string) | ||
| Id (integer) |
Resource id |
|
| FirstName (string) |
First name of the person |
|
| LastName (string) |
Last name of the person |
|
| FullName (string) |
First and last name with a space in between |
|
| Gender (Gender) |
Object containing the gender values NotSpecified, Male, Female and PreferNotToSay |
|
| DateOfBirth (date) |
Format is 9999-12-31 |
|
| Email (string) |
Email address |
|
| Address (GeoAddressApiModelV3) |
Object containing the address (door number, street name, city, state/province, country, zip/postal code, latitude and longitude) |
|
| Telephone (string) |
Telephone number |
|
| TelephoneMobile (string) |
Mobile telephone number |
|
| TelephoneWork (string) |
Work telephone number |
|
| TelephoneWorkExtension (string) |
Work telephone number extension |
|
| IsChild (boolean) |
True when the person is younger than 18 years old |
|