Back to endpoints

Get all waitlisted persons in current activities

GET api/V3/{language}/org/{orgIdentifier}/activities/waitlist

?page={page}

&perPage={perPage}

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

Resource id
Name (string)

Resource name
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
Url (string)

Url of the resource
Status (StateType)

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

For an activity, possible values are Normal, Hidden and Cancelled.

Response Formats

CODE SAMPLE JSON 
[
  {
    "WaitList": [
      {
        "Id": 5,
        "FirstName": "Garry",
        "LastName": "Kasparov",
        "FullName": "Garry Kasparov",
        "DateOfBirth": null,
        "Email": "Garry@email.com",
        "Telephone": "(514) 123-4567",
        "TelephoneMobile": "(212) 1212-212",
        "TelephoneWork": "(123) 456-7890 x123"
      }
    ],
    "Id": 1,
    "Name": "Monday Night Blitz",
    "ProgramId": 2,
    "ProgramName": "Chess Club",
    "CategoryId": 3,
    "CategoryName": "Montreal Chess Club",
    "SubCategoryId": 4,
    "SubCategoryName": "Weekly Club Meetings",
    "Url": "https://google.com",
    "Status": "Normal"
  },
  {
    "WaitList": [
      {
        "Id": 5,
        "FirstName": "Garry",
        "LastName": "Kasparov",
        "FullName": "Garry Kasparov",
        "DateOfBirth": null,
        "Email": "Garry@email.com",
        "Telephone": "(514) 123-4567",
        "TelephoneMobile": "(212) 1212-212",
        "TelephoneWork": "(123) 456-7890 x123"
      }
    ],
    "Id": 1,
    "Name": "Monday Night Blitz",
    "ProgramId": 2,
    "ProgramName": "Chess Club",
    "CategoryId": 3,
    "CategoryName": "Montreal Chess Club",
    "SubCategoryId": 4,
    "SubCategoryName": "Weekly Club Meetings",
    "Url": "https://google.com",
    "Status": "Normal"
  }
]