Back to endpoints

Get the registrations of a person in an organization

GET api/V3/{language}/org/{orgIdentifier}/persons/{id}/registrations

?showEnded={showEnded}

&page={page}

&perPage={perPage}

You can get the person id from org/{orgIdentifier}/persons. Returns a list of registrations ordered by id, with the option to show those from programs that have ended

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)

Person 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
ProgramId (integer)

Id of the program
ProgramName (string)

Part of the hierarchy Program > Category > Subcategory > Activity
CategoryId (integer)

Id of the category
CategoryName (string)

Part of the hierarchy Program > Category > Subcategory > Activity
SubCategoryId (integer)

Id of the subcategory
SubCategoryName (string)

Part of the hierarchy Program > Category > Subcategory > Activity
ActivityId (integer)

Id of the activity
ActivityName (string)

Part of the hierarchy Program > Category > Subcategory > Activity
GroupId (integer)

Id of the group
GroupName (string)

Used when an activity is divided in several groups
DateCreated (date)

Format is 9999-12-31
PersonId (integer)

Id of the person
DropInOccurrenceId (integer)

Null for subscriptions, non-null for drop-ins
DropInDate (date)

Null for subscriptions, non-null for drop-ins
IsCancelled (boolean)

Response Formats

CODE SAMPLE JSON 
{
  "ProgramId": 400004,
  "ProgramName": "Summer 2019",
  "CategoryId": 888333,
  "CategoryName": "Swimming for seniors",
  "SubCategoryId": 555444,
  "SubCategoryName": "Swimming for seniors, Tuesday",
  "ActivityId": 1234567,
  "ActivityName": "Swimming for seniors, Tuesdays 13h",
  "GroupId": 111222,
  "GroupName": "Seniors 1",
  "DateCreated": "2022-09-01T12:47:34.946903-04:00",
  "PersonId": 9191,
  "DropInOccurrenceId": 818181,
  "DropInDate": "2022-09-01T12:47:34-04:00",
  "IsCancelled": false
}