Back to endpoints

Get the participants for an occurrence

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

?page={page}

&perPage={perPage}

You can get the occurrence id from org/{orgIdentifier}/activities/{id}/occurrences. Returns a list of participants ordered by id for an occurrence, regardless of the related activity. N. B. : The term participants has replaced what used to be attendance in V2

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)

Occurrence id

Required
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
Id (integer)

Resource id

AccountId (integer)

Id of the account

FirstName (string)

First name of the person

LastName (string)

Last name of the person

Gender (Gender)

Object containing the gender values NotSpecified, Male, Female and PreferNotToSay

DateOfBirth (date)

Format is 9999-12-31

PictureUrl (string)

Url of the resource picture

GroupId (integer)

Id of the group

GroupName (string)

Used when an activity is divided in several groups

OccurrenceId (integer)

Id of the occurrence

AttendanceId (integer)

Id of the attendance. 0 for None, 1 for Present, 2 for Absent

OrgId (integer)
Status (ActivitySegmentAttendanceStatus)

Object containing the possible status values (case-insensitive).

For the participants of an occurrence, possible values are None, Present and Absent.

UpdatedOn (date)

Date the resource was updated. Format is 9999-12-31

Response Formats

CODE SAMPLE JSON
[
  {
    "Id": 0,
    "AccountId": 0,
    "FirstName": "Georges",
    "LastName": "Tremblay",
    "Gender": 2,
    "DateOfBirth": "0001-01-01",
    "PictureUrl": "photo/de/george",
    "GroupId": 2147483647,
    "GroupName": "Groupe 2",
    "OccurrenceId": 0,
    "AttendanceId": 0,
    "OrgId": 0,
    "Status": "Present",
    "UpdatedOn": "2022-08-13"
  },
  {
    "Id": 0,
    "AccountId": 0,
    "FirstName": "Georges",
    "LastName": "Tremblay",
    "Gender": 2,
    "DateOfBirth": "0001-01-01",
    "PictureUrl": "photo/de/george",
    "GroupId": 2147483647,
    "GroupName": "Groupe 2",
    "OccurrenceId": 0,
    "AttendanceId": 0,
    "OrgId": 0,
    "Status": "Present",
    "UpdatedOn": "2022-08-13"
  }
]