Get private lessons for account
GET api/V3/{language}/org/{orgIdentifier}/accounts/{id}/privateLessons
?showEnded={showEnded}
&page={page}
&perPage={perPage}
You can get the account id from /org/{orgIdentifier}/accounts. Returns a list of private lessons ordered by id, with the option to show lessons that have already taken place.
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) |
Account id |
Required |
| showEnded (boolean) |
Option to show registrations for programs that have ended. Registrations are only valid during a program's lifetime. 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 | ||
|---|---|---|
| Person (PrivateLessonPersonSummaryApiModelV3) | ||
| Staff (PrivateLessonStaffSummaryApiModelV3) |
Object containing staff id, first name, last name and state |
|
| Occurrence (PrivateLessonOccurrenceSummaryApiModelV3) | ||
| DateCreated (date) |
Format is 9999-12-31 |
|