Back to endpoints

Get registration by webhook registration id

GET api/V3/{language}/org/{orgIdentifier}/registrations/{registrationId}

Returns the webhook payload associated with the registration id.

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
registrationId (string)

String Id received from the registration webhook.

Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
RegistrationId (string)
Program (SummaryPayload)
Activity (SummaryPayload)

Object containing the activity details (activity id and name, program id and name, category id and name, subcategory id and name)

Category (SummaryPayload)
SubCategory (SummaryPayload)
Group (SummaryPayload)
DropIn (DropInSummaryPayload)
DateCreated (date)

Format is 9999-12-31

Person (PersonSummaryApiModelV3)
AccountOwner (AccountOwnerSummaryPayload)
Staff (StaffSummaryApiModelV3)

Object containing staff id, first name, last name and state

IsCancelled (boolean)

Response Formats

CODE SAMPLE JSON
{
  "RegistrationId": "AC-123",
  "Program": {
    "Id": 1,
    "Name": "Chess 2020"
  },
  "Activity": {
    "Id": 1,
    "Name": "Fridays 7pm-10pm"
  },
  "Category": {
    "Id": 2,
    "Name": "Club Meetings"
  },
  "SubCategory": {
    "Id": 1,
    "Name": "Montreal Chess Club"
  },
  "Group": {
    "Id": 3,
    "Name": "Chess Champions"
  },
  "DropIn": {
    "OccurrenceId": 5,
    "OccurrenceDate": "2022-08-13T10:41:40.9749272-04:00"
  },
  "DateCreated": "2022-08-13T10:41:40.9749272-04:00",
  "Person": {
    "Id": 7,
    "FirstName": "Bobby",
    "LastName": "Fischer",
    "FullName": "Bobby Fischer",
    "DateOfBirth": null,
    "Email": "bobby@gmail.com",
    "Telephone": "121 212 1212",
    "TelephoneMobile": "555 555 5555",
    "TelephoneWork": "123 456 7890 x1234"
  },
  "AccountOwner": {
    "AccountId": 1234,
    "AccountOwnerPersonId": 321456
  },
  "Staff": {
    "Id": 8,
    "FirstName": "Wilhelm",
    "LastName": "Steinitz",
    "State": "Normal"
  },
  "IsCancelled": false
}