API v3 reference - organization

Version 3 of the Amilia API is the latest supported version. If you are using an older version, we recommend you switch to this one.

BASE URL
https://www.amilia.com/api/v3/{language}/

Accounts

An account can represent either a personal (family) account, or a corporate account. These endpoints give you access to the list of clients you have for your organization.

#

Get accounts

Returns a list of all accounts sorted by id, with the option to show archived accounts


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

No description available

Optional
showArchived (boolean)

Option to also show archived items.

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
CODE SAMPLE JSON
[
  {
    "Id": 0,
    "Owners": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "IsArchived": false,
        "Contacts": [
          {
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "Relationship": "Grandmother",
            "Type": "EmergencyContact"
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2020-01-18"
          }
        ],
        "MedicalInformation": {
          "Allergies": {
            "Nuts": false,
            "Peanuts": false,
            "Eggs": false,
            "InsectSting": false,
            "Seafood": false
          },
          "Sicknesses": {
            "Asthma": false,
            "Incontinence": false,
            "HearingDisorder": false,
            "Diabete": false,
            "Hyperactive": false,
            "Epilepsy": false,
            "VisualDisorder": false,
            "MotorHandicap": false,
            "BehaviorDisorder": false
          },
          "Reactions": "Rash",
          "MedicationDosage": "20 mg",
          "MedicationFrequency": "Twice daily",
          "MedicationOther": "Take with meals",
          "OtherAllergy": "Crab",
          "OtherSickness": "Sea sickness",
          "MedicalStatus": "NoRecord",
          "HasSickness": false,
          "HasAllergy": false
        },
        "JoinDate": "2020-01-18",
        "PictureUrl": "photo_de_maurice.jpg",
        "Id": 0,
        "FirstName": "Maurice",
        "LastName": "Maynard",
        "FullName": "Maurice Maynard",
        "Gender": "Male",
        "DateOfBirth": "0001-01-01",
        "Email": "mau@gmail.com",
        "Address": {
          "Latitude": 45.72,
          "Longitude": -73.5,
          "Address1": "412 des Érables",
          "Address2": "App. 1",
          "City": "Montreal",
          "Country": "Canada",
          "StateProvince": "QC",
          "ZipPostalCode": "H3G 1A1"
        },
        "Telephone": "514 555 5555",
        "TelephoneMobile": "438 555 0000",
        "TelephoneWork": "438 555 5555",
        "TelephoneWorkExtension": "1234",
        "IsChild": false
      }
    ],
    "Members": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "IsArchived": false,
        "Contacts": [
          {
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "Relationship": "Grandmother",
            "Type": "EmergencyContact"
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2020-01-18"
          }
        ],
        "MedicalInformation": {
          "Allergies": {
            "Nuts": false,
            "Peanuts": false,
            "Eggs": false,
            "InsectSting": false,
            "Seafood": false
          },
          "Sicknesses": {
            "Asthma": false,
            "Incontinence": false,
            "HearingDisorder": false,
            "Diabete": false,
            "Hyperactive": false,
            "Epilepsy": false,
            "VisualDisorder": false,
            "MotorHandicap": false,
            "BehaviorDisorder": false
          },
          "Reactions": "Rash",
          "MedicationDosage": "20 mg",
          "MedicationFrequency": "Twice daily",
          "MedicationOther": "Take with meals",
          "OtherAllergy": "Crab",
          "OtherSickness": "Sea sickness",
          "MedicalStatus": "NoRecord",
          "HasSickness": false,
          "HasAllergy": false
        },
        "JoinDate": "2020-01-18",
        "PictureUrl": "photo_de_maurice.jpg",
        "Id": 0,
        "FirstName": "Maurice",
        "LastName": "Maynard",
        "FullName": "Maurice Maynard",
        "Gender": "Male",
        "DateOfBirth": "0001-01-01",
        "Email": "mau@gmail.com",
        "Address": {
          "Latitude": 45.72,
          "Longitude": -73.5,
          "Address1": "412 des Érables",
          "Address2": "App. 1",
          "City": "Montreal",
          "Country": "Canada",
          "StateProvince": "QC",
          "ZipPostalCode": "H3G 1A1"
        },
        "Telephone": "514 555 5555",
        "TelephoneMobile": "438 555 0000",
        "TelephoneWork": "438 555 5555",
        "TelephoneWorkExtension": "1234",
        "IsChild": false
      }
    ],
    "Corporate": {
      "Id": 0,
      "CompanyName": "Acme Inc.",
      "Email": "acme@acme.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "32 Seymour Street",
        "Address2": "",
        "City": "Kamloops",
        "Country": "Canada",
        "StateProvince": "BC",
        "ZipPostalCode": "V2C 2A1"
      },
      "PictureUrl": "img/ourbusiness.jpg",
      "Website": "www.acme.com",
      "Telephone": "555 555 5555",
      "TelephoneOther": "555 444 3333",
      "OrganizationId": 0,
      "AccountId": 0,
      "IsArchived": false,
      "Contact": {
        "FirstName": "Edgar",
        "LastName": "Smith",
        "Title": "Chief Officer",
        "Email": "esmith@acme.com",
        "Telephone": "555 444 3210"
      }
    }
  },
  {
    "Id": 0,
    "Owners": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "IsArchived": false,
        "Contacts": [
          {
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "Relationship": "Grandmother",
            "Type": "EmergencyContact"
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2020-01-18"
          }
        ],
        "MedicalInformation": {
          "Allergies": {
            "Nuts": false,
            "Peanuts": false,
            "Eggs": false,
            "InsectSting": false,
            "Seafood": false
          },
          "Sicknesses": {
            "Asthma": false,
            "Incontinence": false,
            "HearingDisorder": false,
            "Diabete": false,
            "Hyperactive": false,
            "Epilepsy": false,
            "VisualDisorder": false,
            "MotorHandicap": false,
            "BehaviorDisorder": false
          },
          "Reactions": "Rash",
          "MedicationDosage": "20 mg",
          "MedicationFrequency": "Twice daily",
          "MedicationOther": "Take with meals",
          "OtherAllergy": "Crab",
          "OtherSickness": "Sea sickness",
          "MedicalStatus": "NoRecord",
          "HasSickness": false,
          "HasAllergy": false
        },
        "JoinDate": "2020-01-18",
        "PictureUrl": "photo_de_maurice.jpg",
        "Id": 0,
        "FirstName": "Maurice",
        "LastName": "Maynard",
        "FullName": "Maurice Maynard",
        "Gender": "Male",
        "DateOfBirth": "0001-01-01",
        "Email": "mau@gmail.com",
        "Address": {
          "Latitude": 45.72,
          "Longitude": -73.5,
          "Address1": "412 des Érables",
          "Address2": "App. 1",
          "City": "Montreal",
          "Country": "Canada",
          "StateProvince": "QC",
          "ZipPostalCode": "H3G 1A1"
        },
        "Telephone": "514 555 5555",
        "TelephoneMobile": "438 555 0000",
        "TelephoneWork": "438 555 5555",
        "TelephoneWorkExtension": "1234",
        "IsChild": false
      }
    ],
    "Members": [
      {
        "OrganizationId": 77132,
        "AccountId": 818188,
        "AccountOwnerId": 398313,
        "AccountOwnerFirstName": "Mario",
        "AccountOwnerLastName": "Viau",
        "AccountOwnerFullName": "Mario Viau",
        "AccountOwnerEmail": "mario@monadresse.ca",
        "IsArchived": false,
        "Contacts": [
          {
            "Id": 0,
            "FirstName": "Georgette",
            "LastName": "Plouffe",
            "FullName": "Georgette Plouffe",
            "Email": "allo@videotron.ca",
            "Telephone": "514 555 9999",
            "Relationship": "Grandmother",
            "Type": "EmergencyContact"
          }
        ],
        "Skills": [
          {
            "Id": 88,
            "Name": "Rescue",
            "AwardedDate": "2020-01-18"
          }
        ],
        "MedicalInformation": {
          "Allergies": {
            "Nuts": false,
            "Peanuts": false,
            "Eggs": false,
            "InsectSting": false,
            "Seafood": false
          },
          "Sicknesses": {
            "Asthma": false,
            "Incontinence": false,
            "HearingDisorder": false,
            "Diabete": false,
            "Hyperactive": false,
            "Epilepsy": false,
            "VisualDisorder": false,
            "MotorHandicap": false,
            "BehaviorDisorder": false
          },
          "Reactions": "Rash",
          "MedicationDosage": "20 mg",
          "MedicationFrequency": "Twice daily",
          "MedicationOther": "Take with meals",
          "OtherAllergy": "Crab",
          "OtherSickness": "Sea sickness",
          "MedicalStatus": "NoRecord",
          "HasSickness": false,
          "HasAllergy": false
        },
        "JoinDate": "2020-01-18",
        "PictureUrl": "photo_de_maurice.jpg",
        "Id": 0,
        "FirstName": "Maurice",
        "LastName": "Maynard",
        "FullName": "Maurice Maynard",
        "Gender": "Male",
        "DateOfBirth": "0001-01-01",
        "Email": "mau@gmail.com",
        "Address": {
          "Latitude": 45.72,
          "Longitude": -73.5,
          "Address1": "412 des Érables",
          "Address2": "App. 1",
          "City": "Montreal",
          "Country": "Canada",
          "StateProvince": "QC",
          "ZipPostalCode": "H3G 1A1"
        },
        "Telephone": "514 555 5555",
        "TelephoneMobile": "438 555 0000",
        "TelephoneWork": "438 555 5555",
        "TelephoneWorkExtension": "1234",
        "IsChild": false
      }
    ],
    "Corporate": {
      "Id": 0,
      "CompanyName": "Acme Inc.",
      "Email": "acme@acme.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "32 Seymour Street",
        "Address2": "",
        "City": "Kamloops",
        "Country": "Canada",
        "StateProvince": "BC",
        "ZipPostalCode": "V2C 2A1"
      },
      "PictureUrl": "img/ourbusiness.jpg",
      "Website": "www.acme.com",
      "Telephone": "555 555 5555",
      "TelephoneOther": "555 444 3333",
      "OrganizationId": 0,
      "AccountId": 0,
      "IsArchived": false,
      "Contact": {
        "FirstName": "Edgar",
        "LastName": "Smith",
        "Title": "Chief Officer",
        "Email": "esmith@acme.com",
        "Telephone": "555 444 3210"
      }
    }
  }
]

#

Get an account

You can get the account id from /org/{orgIdentifier}/accounts. Returns an account with the option to show the medical information of the persons in it


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
showMedicalInfo (boolean)

Option to show the persons' medical information.

Default value is False

Optional
CODE SAMPLE JSON
{
  "Id": 0,
  "Owners": [
    {
      "OrganizationId": 77132,
      "AccountId": 818188,
      "AccountOwnerId": 398313,
      "AccountOwnerFirstName": "Mario",
      "AccountOwnerLastName": "Viau",
      "AccountOwnerFullName": "Mario Viau",
      "AccountOwnerEmail": "mario@monadresse.ca",
      "IsArchived": false,
      "Contacts": [
        {
          "Id": 0,
          "FirstName": "Georgette",
          "LastName": "Plouffe",
          "FullName": "Georgette Plouffe",
          "Email": "allo@videotron.ca",
          "Telephone": "514 555 9999",
          "Relationship": "Grandmother",
          "Type": "EmergencyContact"
        }
      ],
      "Skills": [
        {
          "Id": 88,
          "Name": "Rescue",
          "AwardedDate": "2020-01-18"
        }
      ],
      "MedicalInformation": {
        "Allergies": {
          "Nuts": false,
          "Peanuts": false,
          "Eggs": false,
          "InsectSting": false,
          "Seafood": false
        },
        "Sicknesses": {
          "Asthma": false,
          "Incontinence": false,
          "HearingDisorder": false,
          "Diabete": false,
          "Hyperactive": false,
          "Epilepsy": false,
          "VisualDisorder": false,
          "MotorHandicap": false,
          "BehaviorDisorder": false
        },
        "Reactions": "Rash",
        "MedicationDosage": "20 mg",
        "MedicationFrequency": "Twice daily",
        "MedicationOther": "Take with meals",
        "OtherAllergy": "Crab",
        "OtherSickness": "Sea sickness",
        "MedicalStatus": "NoRecord",
        "HasSickness": false,
        "HasAllergy": false
      },
      "JoinDate": "2020-01-18",
      "PictureUrl": "photo_de_maurice.jpg",
      "Id": 0,
      "FirstName": "Maurice",
      "LastName": "Maynard",
      "FullName": "Maurice Maynard",
      "Gender": "Male",
      "DateOfBirth": "0001-01-01",
      "Email": "mau@gmail.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "412 des Érables",
        "Address2": "App. 1",
        "City": "Montreal",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "H3G 1A1"
      },
      "Telephone": "514 555 5555",
      "TelephoneMobile": "438 555 0000",
      "TelephoneWork": "438 555 5555",
      "TelephoneWorkExtension": "1234",
      "IsChild": false
    }
  ],
  "Members": [
    {
      "OrganizationId": 77132,
      "AccountId": 818188,
      "AccountOwnerId": 398313,
      "AccountOwnerFirstName": "Mario",
      "AccountOwnerLastName": "Viau",
      "AccountOwnerFullName": "Mario Viau",
      "AccountOwnerEmail": "mario@monadresse.ca",
      "IsArchived": false,
      "Contacts": [
        {
          "Id": 0,
          "FirstName": "Georgette",
          "LastName": "Plouffe",
          "FullName": "Georgette Plouffe",
          "Email": "allo@videotron.ca",
          "Telephone": "514 555 9999",
          "Relationship": "Grandmother",
          "Type": "EmergencyContact"
        }
      ],
      "Skills": [
        {
          "Id": 88,
          "Name": "Rescue",
          "AwardedDate": "2020-01-18"
        }
      ],
      "MedicalInformation": {
        "Allergies": {
          "Nuts": false,
          "Peanuts": false,
          "Eggs": false,
          "InsectSting": false,
          "Seafood": false
        },
        "Sicknesses": {
          "Asthma": false,
          "Incontinence": false,
          "HearingDisorder": false,
          "Diabete": false,
          "Hyperactive": false,
          "Epilepsy": false,
          "VisualDisorder": false,
          "MotorHandicap": false,
          "BehaviorDisorder": false
        },
        "Reactions": "Rash",
        "MedicationDosage": "20 mg",
        "MedicationFrequency": "Twice daily",
        "MedicationOther": "Take with meals",
        "OtherAllergy": "Crab",
        "OtherSickness": "Sea sickness",
        "MedicalStatus": "NoRecord",
        "HasSickness": false,
        "HasAllergy": false
      },
      "JoinDate": "2020-01-18",
      "PictureUrl": "photo_de_maurice.jpg",
      "Id": 0,
      "FirstName": "Maurice",
      "LastName": "Maynard",
      "FullName": "Maurice Maynard",
      "Gender": "Male",
      "DateOfBirth": "0001-01-01",
      "Email": "mau@gmail.com",
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "412 des Érables",
        "Address2": "App. 1",
        "City": "Montreal",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "H3G 1A1"
      },
      "Telephone": "514 555 5555",
      "TelephoneMobile": "438 555 0000",
      "TelephoneWork": "438 555 5555",
      "TelephoneWorkExtension": "1234",
      "IsChild": false
    }
  ],
  "Corporate": {
    "Id": 0,
    "CompanyName": "Acme Inc.",
    "Email": "acme@acme.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "32 Seymour Street",
      "Address2": "",
      "City": "Kamloops",
      "Country": "Canada",
      "StateProvince": "BC",
      "ZipPostalCode": "V2C 2A1"
    },
    "PictureUrl": "img/ourbusiness.jpg",
    "Website": "www.acme.com",
    "Telephone": "555 555 5555",
    "TelephoneOther": "555 444 3333",
    "OrganizationId": 0,
    "AccountId": 0,
    "IsArchived": false,
    "Contact": {
      "FirstName": "Edgar",
      "LastName": "Smith",
      "Title": "Chief Officer",
      "Email": "esmith@acme.com",
      "Telephone": "555 444 3210"
    }
  }
}

#

Get contacts for an account

You can get the account id from /org/{orgIdentifier}/accounts. Returns a list of persons entered in the account as contacts


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
CODE SAMPLE JSON
[
  {
    "Id": 0,
    "FirstName": "Simone",
    "LastName": "Samson",
    "FullName": "Simone Samson",
    "Gender": "NotSpecified",
    "DateOfBirth": "1970-01-01",
    "Email": "simone.samson@amilia.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "111 Yonge St.",
      "Address2": "Apt. 22",
      "City": "Toronto",
      "Country": "Canada",
      "StateProvince": "ON",
      "ZipPostalCode": "M4B 1B3"
    },
    "Telephone": "418 555 0011",
    "TelephoneMobile": "438 555 4444",
    "TelephoneWork": "418 555 7777",
    "TelephoneWorkExtension": "333",
    "IsChild": false
  },
  {
    "Id": 0,
    "FirstName": "Simone",
    "LastName": "Samson",
    "FullName": "Simone Samson",
    "Gender": "NotSpecified",
    "DateOfBirth": "1970-01-01",
    "Email": "simone.samson@amilia.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "111 Yonge St.",
      "Address2": "Apt. 22",
      "City": "Toronto",
      "Country": "Canada",
      "StateProvince": "ON",
      "ZipPostalCode": "M4B 1B3"
    },
    "Telephone": "418 555 0011",
    "TelephoneMobile": "438 555 4444",
    "TelephoneWork": "418 555 7777",
    "TelephoneWorkExtension": "333",
    "IsChild": false
  }
]

#

Get rental contracts

You can get the account id from /org/{orgIdentifier}/accounts. Returns a list of rental contracts ordered by id, with the option to show archived contracts and to filter by contract status


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

Possible values are 'All', 'Approved', 'Draft', and 'PendingApproval'. These values are case-insensitive.

Default value is All

Optional
showArchived (boolean)

Option to also show archived items.

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
CODE SAMPLE JSON
[
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:22.3290585-05:00",
        "End": "2020-01-18T18:42:22.3290585-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  },
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:22.3290585-05:00",
        "End": "2020-01-18T18:42:22.3290585-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  }
]

#

Get registrations

You can get the account id from /org/{orgIdentifier}/accounts. Returns a list of registrations ordered by id, with the options to show registrations to programs that have ended


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
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": "2020-01-18",
    "PersonId": 9191,
    "DropInOccurrenceId": 818181,
    "DropInDate": "2020-01-18T18:42:22.3603128-05:00"
  },
  {
    "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": "2020-01-18",
    "PersonId": 9191,
    "DropInOccurrenceId": 818181,
    "DropInDate": "2020-01-18T18:42:22.3603128-05:00"
  }
]

Activities

In Amilia, an activity is a class or specific offering. Other systems may call this a program, whereas in Amilia a program is a container of similar activities.

#

Get an activity for an organization


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)

Activity id

Required
CODE SAMPLE JSON
{
  "Description": "Soccer outdoors on Fridays 16h-17h",
  "Prerequisite": "Must have passed soccer I",
  "Note": "Bring snacks, tie your hair, no jewelry",
  "ThirdPartyUrl": "merch/soccer",
  "AdditionalInformation": "Bring more snacks",
  "Price": 0.0,
  "DropInPrice": 0.0,
  "Age": {
    "Max": 17,
    "Min": 7,
    "Months": false
  },
  "MaxAttendance": 24,
  "SpotsRemaining": 2,
  "SpotsReserved": 7,
  "NumberOfOccurrences": 0,
  "StartDate": "2020-01-18T00:00:00-05:00",
  "EndDate": "2020-01-18T00:00:00-05:00",
  "ScheduleSummary": "Fridays 16h-17h, 2 May to 27 August",
  "HasSessionEnabled": false,
  "HasDropInEnabled": false,
  "AgeSummary": "7-17",
  "Keywords": [
    {
      "Id": 88,
      "Name": "Soccer"
    }
  ],
  "Groups": [
    {
      "Id": 3,
      "Name": "Melanie"
    },
    {
      "Id": 4,
      "Name": "Doris"
    }
  ],
  "OrganizationId": 0,
  "PictureUrl": "activity/picture.jpg",
  "Id": 0,
  "Name": "Soccer II",
  "ProgramId": 0,
  "ProgramName": "Summer 2019",
  "CategoryId": 56783,
  "CategoryName": "Soccer",
  "SubCategoryId": 56786,
  "SubCategoryName": "",
  "Url": "soccer/2019/fridays",
  "Status": "Normal"
}

#

Get an activity's occurrences for an organization

Returns a list of activity (events), with the option to define a start and end date and to show those that have been edited


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)

Activity id

Required
showEdited (boolean)

Option to show items that have been modified.

Default value is False

Optional
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

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
CODE SAMPLE JSON
[
  {
    "ActivityId": 0,
    "Start": "2020-01-18T00:00:00-05:00",
    "End": "2020-01-18T00:00:00-05:00",
    "State": "Normal",
    "Id": 0,
    "Location": {
      "Id": 0,
      "Name": "Natatorium de Verdun"
    },
    "Staff": []
  },
  {
    "ActivityId": 0,
    "Start": "2020-01-18T00:00:00-05:00",
    "End": "2020-01-18T00:00:00-05:00",
    "State": "Normal",
    "Id": 0,
    "Location": {
      "Id": 0,
      "Name": "Natatorium de Verdun"
    },
    "Staff": []
  }
]

#

Get persons in an activity for an organization

Returns a list of persons subscribed to an activity, with the option to show the persons' registrations, skills and medical information


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)

Activity id

Required
showSkills (boolean)

Option to show relevant skills.

Default value is False

Optional
showRegistrations (boolean)

Option to show the persons who registered.

Default value is False

Optional
showMedicalInfo (boolean)

Option to show the persons' medical information.

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
CODE SAMPLE JSON
[
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-18"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  },
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-18"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  }
]

Authentication

#

Authenticate the user in the API

Returns a token to be used for all other calls. Note that the call (written with the full path below) does not contain the {language} parameter


There are no parameters for this call.

CODE SAMPLE JSON
{
   "Token": "0000aaaa11bbbb4444hh8888rrrr.33dd4455ff.gggg6666" 
}

Events

An event is an activity unit in a unique time slot. The terms event and occurrence are used interchangeably in our platform.

#

Get events for an organization

Retrieves all activity events occurring in the active programs of an organization, for the given date range.

Arguments 'from' and 'to' are dates. If 'to' is omitted, retrieves only for one day specified by 'from'. When both 'from' and 'to' are omitted, returns events for today.

You can also limit the search to a given program given the 'programId' argument, and report the list of participants and their attendance for each returned event by passing 'showParticipants=true'.

This call is useful to build a calendar.


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
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

Optional
programId (integer)

Id of the program in which the event is. Default value is null

Optional
showParticipants (boolean)

Option to show the list of participants and their attendance.

Default value is False

Optional
showHidden (boolean)

Option to return hidden items.

Default value is False

Optional
showSkipped (boolean)

Default value is False

Optional
showCanceled (boolean)

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
CODE SAMPLE JSON
[
  {
    "Start": "2020-01-18T18:42:22.8518532-05:00",
    "End": "2020-01-18T20:42:22.8518532-05:00",
    "AllDay": false,
    "Title": "End of Season Match",
    "Url": "supersport.com/end/of/season/match",
    "Activity": {
      "Id": 0,
      "Name": "End of Season Match",
      "ProgramId": 0,
      "ProgramName": "Summer 2019 Soccer",
      "CategoryId": 0,
      "CategoryName": "Soccer",
      "SubCategoryId": 0,
      "SubCategoryName": "Soccer for Seniors",
      "Url": null,
      "Status": "Normal"
    },
    "Participants": null,
    "State": "Normal",
    "PictureUrl": "end_of_season_match.jpg",
    "Price": 0.0,
    "Tags": [
      {
        "Id": 4,
        "Name": "Soccer",
        "Color": "Orange",
        "IsVisible": true
      }
    ],
    "EventType": "Activity",
    "Id": 0,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 rue Joseph-Gravel",
        "Address2": "",
        "City": "Chambly",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J3L 0C7"
      },
      "Id": 9009,
      "Name": "Parc Joseph-Gravel"
    },
    "Staff": []
  },
  {
    "Start": "2020-01-18T18:42:22.8518532-05:00",
    "End": "2020-01-18T20:42:22.8518532-05:00",
    "AllDay": false,
    "Title": "End of Season Match",
    "Url": "supersport.com/end/of/season/match",
    "Activity": {
      "Id": 0,
      "Name": "End of Season Match",
      "ProgramId": 0,
      "ProgramName": "Summer 2019 Soccer",
      "CategoryId": 0,
      "CategoryName": "Soccer",
      "SubCategoryId": 0,
      "SubCategoryName": "Soccer for Seniors",
      "Url": null,
      "Status": "Normal"
    },
    "Participants": null,
    "State": "Normal",
    "PictureUrl": "end_of_season_match.jpg",
    "Price": 0.0,
    "Tags": [
      {
        "Id": 4,
        "Name": "Soccer",
        "Color": "Orange",
        "IsVisible": true
      }
    ],
    "EventType": "Activity",
    "Id": 0,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 rue Joseph-Gravel",
        "Address2": "",
        "City": "Chambly",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J3L 0C7"
      },
      "Id": 9009,
      "Name": "Parc Joseph-Gravel"
    },
    "Staff": []
  }
]

Keywords

Keywords summarize specific types of and are related to

#

Get keywords

Returns a list of supported keywords, with the option to specify a partner name


PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
partner (string)

Partner name. Default value is null

Optional
CODE SAMPLE JSON
[
  {
    "Id": 0,
    "Name": "Skiing",
    "ParentVerticalId": 842
  },
  {
    "Id": 0,
    "Name": "Skiing",
    "ParentVerticalId": 842
  }
]

#

Get a keyword

Returns an individual keyword by id, with the option to specify a partner name


PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
id (integer)

Keyword id

Required
partner (string)

Partner name. Default value is null

Optional
CODE SAMPLE JSON
{
  "Id": 0,
  "Name": "Skiing",
  "ParentVerticalId": 842
}

Locations

Physical places where activities happen

#

Get locations for an organization

Returns all the locations that have been defined for your organization. You must specify area type and coordinates. You also have the option to specify a radius and an activity keyword id. You can also show children locations that have the given keyword


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

Shape of search area: circle (search by Radius), rectangle (search by BoundingBox) or polygon (search by Polygon).

Optional
coordinates (list of doubles)

Pairs of points on a 2D map. Each pair has the format 45.00,73.00. Extra pairs are appended with a comma like so: 45.00,73.00,10.00,10.00. In the search by BoundingBox, the rectangle is defined by its top-left and bottom-right coordinates (so four numbers).In the search by Polygon, the polygon is defined by all its coordinates (an even number of numbers, and more than four numbers). The polygon points must be ordered either clockwise or counterclockwise to prevent the enclosed area from folding over itself and give unexpected results.

Optional
radius (integer)

In the search by Radius, the circle is defined by its radius in km. Default value is null

Optional
keywordId (integer)

Activity keyword id. Default value is null

Optional
showChildrenKeywords (boolean)

Option to also show children locations containing the given keywords

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
CODE SAMPLE JSON
[
  {
    "FullName": "Natatorium de Verdun",
    "Description": "Piscines profonde et moyenne, pataugeoire",
    "Telephone": "514 555 1111",
    "TelephoneExtension": "324",
    "ParentId": 5432,
    "TopParentId": 33,
    "AncestorIds": [
      5432,
      6852,
      33
    ],
    "Keywords": [
      {
        "Id": 34,
        "Name": "Swimming"
      },
      {
        "Id": 41,
        "Name": "Rescue"
      }
    ],
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "9000 boul. Lasalle",
      "Address2": "",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H4E 1P4"
    },
    "Id": 0,
    "Name": "Natatorium"
  },
  {
    "FullName": "Natatorium de Verdun",
    "Description": "Piscines profonde et moyenne, pataugeoire",
    "Telephone": "514 555 1111",
    "TelephoneExtension": "324",
    "ParentId": 5432,
    "TopParentId": 33,
    "AncestorIds": [
      5432,
      6852,
      33
    ],
    "Keywords": [
      {
        "Id": 34,
        "Name": "Swimming"
      },
      {
        "Id": 41,
        "Name": "Rescue"
      }
    ],
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "9000 boul. Lasalle",
      "Address2": "",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H4E 1P4"
    },
    "Id": 0,
    "Name": "Natatorium"
  }
]

#

Get an organization's activities by location

You can get the location id from /org/{orgIdentifier}/locations. Returns a list of taking place at the given location, with the option to specify a keyword id and to show hidden and cancelled activities, activities in child locations and child locations containing the given keyword


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)

Location id

Required
showHidden (boolean)

Option to return hidden items.

Default value is False

Optional
showCancelled (boolean)

Option to also return cancelled items.

Default value is False

Optional
showChildrenActivities (boolean)

Option to also show activities in children locations.

Default value is False

Optional
keywordId (integer)

Activity keyword id. Default value is null

Optional
showChildrenKeywords (boolean)

Option to also show children locations containing the given keywords

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
CODE SAMPLE JSON
[
  {
    "Description": "Soccer outdoors on Fridays 16h-17h",
    "Prerequisite": "Must have passed soccer I",
    "Note": "Bring snacks, tie your hair, no jewelry",
    "ThirdPartyUrl": "merch/soccer",
    "AdditionalInformation": "Bring more snacks",
    "Price": 0.0,
    "DropInPrice": 0.0,
    "Age": {
      "Max": 17,
      "Min": 7,
      "Months": false
    },
    "MaxAttendance": 24,
    "SpotsRemaining": 2,
    "SpotsReserved": 7,
    "NumberOfOccurrences": 0,
    "StartDate": "2020-01-18T00:00:00-05:00",
    "EndDate": "2020-01-18T00:00:00-05:00",
    "ScheduleSummary": "Fridays 16h-17h, 2 May to 27 August",
    "HasSessionEnabled": false,
    "HasDropInEnabled": false,
    "AgeSummary": "7-17",
    "Keywords": [
      {
        "Id": 88,
        "Name": "Soccer"
      }
    ],
    "Groups": [
      {
        "Id": 3,
        "Name": "Melanie"
      },
      {
        "Id": 4,
        "Name": "Doris"
      }
    ],
    "OrganizationId": 0,
    "PictureUrl": "activity/picture.jpg",
    "Id": 0,
    "Name": "Soccer II",
    "ProgramId": 0,
    "ProgramName": "Summer 2019",
    "CategoryId": 56783,
    "CategoryName": "Soccer",
    "SubCategoryId": 56786,
    "SubCategoryName": "",
    "Url": "soccer/2019/fridays",
    "Status": "Normal"
  },
  {
    "Description": "Soccer outdoors on Fridays 16h-17h",
    "Prerequisite": "Must have passed soccer I",
    "Note": "Bring snacks, tie your hair, no jewelry",
    "ThirdPartyUrl": "merch/soccer",
    "AdditionalInformation": "Bring more snacks",
    "Price": 0.0,
    "DropInPrice": 0.0,
    "Age": {
      "Max": 17,
      "Min": 7,
      "Months": false
    },
    "MaxAttendance": 24,
    "SpotsRemaining": 2,
    "SpotsReserved": 7,
    "NumberOfOccurrences": 0,
    "StartDate": "2020-01-18T00:00:00-05:00",
    "EndDate": "2020-01-18T00:00:00-05:00",
    "ScheduleSummary": "Fridays 16h-17h, 2 May to 27 August",
    "HasSessionEnabled": false,
    "HasDropInEnabled": false,
    "AgeSummary": "7-17",
    "Keywords": [
      {
        "Id": 88,
        "Name": "Soccer"
      }
    ],
    "Groups": [
      {
        "Id": 3,
        "Name": "Melanie"
      },
      {
        "Id": 4,
        "Name": "Doris"
      }
    ],
    "OrganizationId": 0,
    "PictureUrl": "activity/picture.jpg",
    "Id": 0,
    "Name": "Soccer II",
    "ProgramId": 0,
    "ProgramName": "Summer 2019",
    "CategoryId": 56783,
    "CategoryName": "Soccer",
    "SubCategoryId": 56786,
    "SubCategoryName": "",
    "Url": "soccer/2019/fridays",
    "Status": "Normal"
  }
]

#

Get a location for an organization

You can get the location id from /org/{orgIdentifier}/locations


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)

Location id

Required
CODE SAMPLE JSON
{
  "FullName": "Natatorium de Verdun",
  "Description": "Piscines profonde et moyenne, pataugeoire",
  "Telephone": "514 555 1111",
  "TelephoneExtension": "324",
  "ParentId": 5432,
  "TopParentId": 33,
  "AncestorIds": [
    5432,
    6852,
    33
  ],
  "Keywords": [
    {
      "Id": 34,
      "Name": "Swimming"
    },
    {
      "Id": 41,
      "Name": "Rescue"
    }
  ],
  "Address": {
    "Latitude": 45.72,
    "Longitude": -73.5,
    "Address1": "9000 boul. Lasalle",
    "Address2": "",
    "City": "Montreal",
    "Country": "Canada",
    "StateProvince": "QC",
    "ZipPostalCode": "H4E 1P4"
  },
  "Id": 0,
  "Name": "Natatorium"
}

Memberships

A membership can take different forms: it can be a membership card, an annual fee, an activity-specific membership, etc.

#

Get the memberships for an organization

Returns a list of memberships ordered by id, with the option to show the hidden ones


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
showHidden (boolean)

Option to return hidden items.

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
CODE SAMPLE JSON
[
  {
    "Id": 0,
    "OrganizationId": 0,
    "Name": "Early bird membership",
    "Description": "From 6AM to 9AM",
    "Price": 0.0,
    "Position": 0,
    "IsArchived": false,
    "IsVisible": false,
    "DateCreated": "0001-01-01",
    "MembershipType": "IndividualPerson",
    "LedgerCode": {
      "Id": 31,
      "Name": "Summer2019"
    },
    "Tags": [
      {
        "Id": 4,
        "Name": "VIP"
      },
      {
        "Id": 5,
        "Name": "Summer 2019"
      }
    ],
    "IndividualMembership": {
      "AgeRestriction": {
        "Age": {
          "AgeMin": 11,
          "AgeMax": 99,
          "IsAgeInMonths": false
        },
        "AgeRestrictionInDateOf": "2020-01-18"
      },
      "SkillsRestriction": {
        "Skills": [
          {
            "Id": 1,
            "Name": "Swimming"
          },
          {
            "Id": 2,
            "Name": "Rowing"
          }
        ],
        "Age": {
          "AgeMin": 11,
          "AgeMax": 99,
          "IsAgeInMonths": false
        },
        "SkillRestrictionType": "Survival around water"
      },
      "GenderRestriction": [
        "Female"
      ],
      "FixedDates": {
        "EffectiveDate": "2020-01-18",
        "ExpirationDate": "2020-01-18",
        "SalesDate": "2020-01-18"
      },
      "FixedDuration": {
        "Duration": 8,
        "RecurrenceUnitType": "week",
        "RenewInterval": 8,
        "RenewIntervalUnitType": "week"
      },
      "Merchandise": [
        {
          "Id": 8,
          "Name": "Floating device"
        }
      ],
      "ReplacementStatus": "Disabled",
      "ReplacementConstraints": [
        {
          "Id": 9,
          "Name": "Must be used within the year"
        }
      ]
    },
    "CorporateMembership": {
      "FixedDates": {
        "EffectiveDate": "2020-01-18",
        "ExpirationDate": "2020-01-18",
        "SalesDate": "2020-01-18"
      },
      "FixedDuration": {
        "Duration": 8,
        "RecurrenceUnitType": "week",
        "RenewInterval": 8,
        "RenewIntervalUnitType": "week"
      },
      "Merchandise": [
        {
          "Id": 8,
          "Name": "Floating device"
        }
      ],
      "ReplacementStatus": "EnabledWithRestrictions",
      "ReplacementConstraints": [
        {
          "Id": 11,
          "Name": "Must be used within one year"
        }
      ]
    }
  },
  {
    "Id": 0,
    "OrganizationId": 0,
    "Name": "Early bird membership",
    "Description": "From 6AM to 9AM",
    "Price": 0.0,
    "Position": 0,
    "IsArchived": false,
    "IsVisible": false,
    "DateCreated": "0001-01-01",
    "MembershipType": "IndividualPerson",
    "LedgerCode": {
      "Id": 31,
      "Name": "Summer2019"
    },
    "Tags": [
      {
        "Id": 4,
        "Name": "VIP"
      },
      {
        "Id": 5,
        "Name": "Summer 2019"
      }
    ],
    "IndividualMembership": {
      "AgeRestriction": {
        "Age": {
          "AgeMin": 11,
          "AgeMax": 99,
          "IsAgeInMonths": false
        },
        "AgeRestrictionInDateOf": "2020-01-18"
      },
      "SkillsRestriction": {
        "Skills": [
          {
            "Id": 1,
            "Name": "Swimming"
          },
          {
            "Id": 2,
            "Name": "Rowing"
          }
        ],
        "Age": {
          "AgeMin": 11,
          "AgeMax": 99,
          "IsAgeInMonths": false
        },
        "SkillRestrictionType": "Survival around water"
      },
      "GenderRestriction": [
        "Female"
      ],
      "FixedDates": {
        "EffectiveDate": "2020-01-18",
        "ExpirationDate": "2020-01-18",
        "SalesDate": "2020-01-18"
      },
      "FixedDuration": {
        "Duration": 8,
        "RecurrenceUnitType": "week",
        "RenewInterval": 8,
        "RenewIntervalUnitType": "week"
      },
      "Merchandise": [
        {
          "Id": 8,
          "Name": "Floating device"
        }
      ],
      "ReplacementStatus": "Disabled",
      "ReplacementConstraints": [
        {
          "Id": 9,
          "Name": "Must be used within the year"
        }
      ]
    },
    "CorporateMembership": {
      "FixedDates": {
        "EffectiveDate": "2020-01-18",
        "ExpirationDate": "2020-01-18",
        "SalesDate": "2020-01-18"
      },
      "FixedDuration": {
        "Duration": 8,
        "RecurrenceUnitType": "week",
        "RenewInterval": 8,
        "RenewIntervalUnitType": "week"
      },
      "Merchandise": [
        {
          "Id": 8,
          "Name": "Floating device"
        }
      ],
      "ReplacementStatus": "EnabledWithRestrictions",
      "ReplacementConstraints": [
        {
          "Id": 11,
          "Name": "Must be used within one year"
        }
      ]
    }
  }
]

#

Get a membership for an organization

You can get the membership id from /org/{orgIdentifier}/memberships


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)

Membership id

Required
CODE SAMPLE JSON
{
  "Id": 0,
  "OrganizationId": 0,
  "Name": "Early bird membership",
  "Description": "From 6AM to 9AM",
  "Price": 0.0,
  "Position": 0,
  "IsArchived": false,
  "IsVisible": false,
  "DateCreated": "0001-01-01",
  "MembershipType": "IndividualPerson",
  "LedgerCode": {
    "Id": 31,
    "Name": "Summer2019"
  },
  "Tags": [
    {
      "Id": 4,
      "Name": "VIP"
    },
    {
      "Id": 5,
      "Name": "Summer 2019"
    }
  ],
  "IndividualMembership": {
    "AgeRestriction": {
      "Age": {
        "AgeMin": 11,
        "AgeMax": 99,
        "IsAgeInMonths": false
      },
      "AgeRestrictionInDateOf": "2020-01-18"
    },
    "SkillsRestriction": {
      "Skills": [
        {
          "Id": 1,
          "Name": "Swimming"
        },
        {
          "Id": 2,
          "Name": "Rowing"
        }
      ],
      "Age": {
        "AgeMin": 11,
        "AgeMax": 99,
        "IsAgeInMonths": false
      },
      "SkillRestrictionType": "Survival around water"
    },
    "GenderRestriction": [
      "Female"
    ],
    "FixedDates": {
      "EffectiveDate": "2020-01-18",
      "ExpirationDate": "2020-01-18",
      "SalesDate": "2020-01-18"
    },
    "FixedDuration": {
      "Duration": 8,
      "RecurrenceUnitType": "week",
      "RenewInterval": 8,
      "RenewIntervalUnitType": "week"
    },
    "Merchandise": [
      {
        "Id": 8,
        "Name": "Floating device"
      }
    ],
    "ReplacementStatus": "Disabled",
    "ReplacementConstraints": [
      {
        "Id": 9,
        "Name": "Must be used within the year"
      }
    ]
  },
  "CorporateMembership": {
    "FixedDates": {
      "EffectiveDate": "2020-01-18",
      "ExpirationDate": "2020-01-18",
      "SalesDate": "2020-01-18"
    },
    "FixedDuration": {
      "Duration": 8,
      "RecurrenceUnitType": "week",
      "RenewInterval": 8,
      "RenewIntervalUnitType": "week"
    },
    "Merchandise": [
      {
        "Id": 8,
        "Name": "Floating device"
      }
    ],
    "ReplacementStatus": "EnabledWithRestrictions",
    "ReplacementConstraints": [
      {
        "Id": 11,
        "Name": "Must be used within one year"
      }
    ]
  }
}

#

Get persons in a membership for an organization

You can get the membership id from /org/{orgIdentifier}/memberships. Returns a list of persons ordered by id, with the option to specify the membership's status, start and end dates and whether to show the medical information (if any) for each person


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)

Membership id

Required
status (string)

Possible values are 'Active', 'Inactive', 'Expired', and 'All'. These values are case-insensitive.

Default value is active

Optional
showMedicalInfo (boolean)

Option to show the persons' medical information.

Default value is False

Optional
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

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
CODE SAMPLE JSON
[
  {
    "PurchasedDate": "2020-01-18",
    "EffectiveDate": "2020-01-18",
    "ExpirationDate": "2020-01-18",
    "OrganizationId": 986987,
    "AccountId": 171717,
    "AccountOwnerId": 432112,
    "AccountOwnerFirstName": "Gertrude",
    "AccountOwnerLastName": "Godin",
    "AccountOwnerFullName": "Gertrude Godin",
    "AccountOwnerEmail": "gertrude89@monmail.com",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 0,
        "Name": "Rescue",
        "AwardedDate": "0001-01-01"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "myclub.ca/memberpics/gertrude_godin",
    "Id": 0,
    "FirstName": "Joelle",
    "LastName": "Godin",
    "FullName": "Joelle Godin",
    "Gender": 0,
    "DateOfBirth": "2020-01-18",
    "Email": "joelle111@monmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "888 boul. Chomedey",
      "Address2": "",
      "City": "Laval",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H1H 1H1"
    },
    "Telephone": "450 555 5555",
    "TelephoneMobile": "438 555 5555",
    "TelephoneWork": "514 555 5555",
    "TelephoneWorkExtension": "9999",
    "IsChild": true
  },
  {
    "PurchasedDate": "2020-01-18",
    "EffectiveDate": "2020-01-18",
    "ExpirationDate": "2020-01-18",
    "OrganizationId": 986987,
    "AccountId": 171717,
    "AccountOwnerId": 432112,
    "AccountOwnerFirstName": "Gertrude",
    "AccountOwnerLastName": "Godin",
    "AccountOwnerFullName": "Gertrude Godin",
    "AccountOwnerEmail": "gertrude89@monmail.com",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 0,
        "Name": "Rescue",
        "AwardedDate": "0001-01-01"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "myclub.ca/memberpics/gertrude_godin",
    "Id": 0,
    "FirstName": "Joelle",
    "LastName": "Godin",
    "FullName": "Joelle Godin",
    "Gender": 0,
    "DateOfBirth": "2020-01-18",
    "Email": "joelle111@monmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "888 boul. Chomedey",
      "Address2": "",
      "City": "Laval",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H1H 1H1"
    },
    "Telephone": "450 555 5555",
    "TelephoneMobile": "438 555 5555",
    "TelephoneWork": "514 555 5555",
    "TelephoneWorkExtension": "9999",
    "IsChild": true
  }
]

Occurrences

An occurrence is an activity unit in a unique time slot. The terms event and occurrence are used interchangeably in our platform.

#

Get the participants for an occurrence

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


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
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": "2020-01-18"
  },
  {
    "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": "2020-01-18"
  }
]

Persons

Persons are the people registered in your database

#

Get the persons in an organization

Returns a list of persons ordered by id, with the option to show skills, medical information and archived persons


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
showArchived (boolean)

Option to also show archived items.

Default value is False

Optional
showSkills (boolean)

Option to show relevant skills.

Default value is False

Optional
showMedicalInfo (boolean)

Option to show the persons' medical information.

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
CODE SAMPLE JSON
[
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-18"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  },
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-18"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-18",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  }
]

#

Get a person in an organization

You can get the person id from org/{orgIdentifier}/persons. Returns a person with the option to show their medical information


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
showMedicalInfo (boolean)

Option to show the persons' medical information.

Default value is False

Optional
CODE SAMPLE JSON
{
  "OrganizationId": 77132,
  "AccountId": 818188,
  "AccountOwnerId": 398313,
  "AccountOwnerFirstName": "Mario",
  "AccountOwnerLastName": "Viau",
  "AccountOwnerFullName": "Mario Viau",
  "AccountOwnerEmail": "mario@monadresse.ca",
  "IsArchived": false,
  "Contacts": [
    {
      "Id": 0,
      "FirstName": "Georgette",
      "LastName": "Plouffe",
      "FullName": "Georgette Plouffe",
      "Email": "allo@videotron.ca",
      "Telephone": "514 555 9999",
      "Relationship": "Grandmother",
      "Type": "EmergencyContact"
    }
  ],
  "Skills": [
    {
      "Id": 88,
      "Name": "Rescue",
      "AwardedDate": "2020-01-18"
    }
  ],
  "MedicalInformation": {
    "Allergies": {
      "Nuts": false,
      "Peanuts": false,
      "Eggs": false,
      "InsectSting": false,
      "Seafood": false
    },
    "Sicknesses": {
      "Asthma": false,
      "Incontinence": false,
      "HearingDisorder": false,
      "Diabete": false,
      "Hyperactive": false,
      "Epilepsy": false,
      "VisualDisorder": false,
      "MotorHandicap": false,
      "BehaviorDisorder": false
    },
    "Reactions": "Rash",
    "MedicationDosage": "20 mg",
    "MedicationFrequency": "Twice daily",
    "MedicationOther": "Take with meals",
    "OtherAllergy": "Crab",
    "OtherSickness": "Sea sickness",
    "MedicalStatus": "NoRecord",
    "HasSickness": false,
    "HasAllergy": false
  },
  "JoinDate": "2020-01-18",
  "PictureUrl": "photo_de_maurice.jpg",
  "Id": 0,
  "FirstName": "Maurice",
  "LastName": "Maynard",
  "FullName": "Maurice Maynard",
  "Gender": "Male",
  "DateOfBirth": "0001-01-01",
  "Email": "mau@gmail.com",
  "Address": {
    "Latitude": 45.72,
    "Longitude": -73.5,
    "Address1": "412 des Érables",
    "Address2": "App. 1",
    "City": "Montreal",
    "Country": "Canada",
    "StateProvince": "QC",
    "ZipPostalCode": "H3G 1A1"
  },
  "Telephone": "514 555 5555",
  "TelephoneMobile": "438 555 0000",
  "TelephoneWork": "438 555 5555",
  "TelephoneWorkExtension": "1234",
  "IsChild": false
}

#

Get the registrations of a person in an organization

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


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
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": "2020-01-18",
  "PersonId": 9191,
  "DropInOccurrenceId": 818181,
  "DropInDate": "2020-01-18T18:42:23.3679848-05:00"
}

Program

A program is a set of activities organized in a hierarchy. It can have categories and subcategories.

#

Get programs for an organization

Returns a list of programs ordered by id, with the option to show hidden and archived programs


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
showHidden (boolean)

Option to return hidden items.

Default value is False

Optional
showArchived (boolean)

Option to also show archived items.

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
CODE SAMPLE JSON
[
  {
    "Id": 0,
    "Name": "Summer 2019",
    "Start": "0001-01-01T00:00:00-05:00",
    "End": "9999-12-31T18:59:59.9999999-05:00",
    "Url": "www.acme.com/summer2019",
    "PictureUrl": "img/summer2019.jpg",
    "IsArchived": false,
    "IsVisible": false
  },
  {
    "Id": 0,
    "Name": "Summer 2019",
    "Start": "0001-01-01T00:00:00-05:00",
    "End": "9999-12-31T18:59:59.9999999-05:00",
    "Url": "www.acme.com/summer2019",
    "PictureUrl": "img/summer2019.jpg",
    "IsArchived": false,
    "IsVisible": false
  }
]

#

Get a program's activities for an organization

You can get the program id from org/{orgIdentifier}/programs. Returns a list of ordered by id, with the option to show hidden and cancelled activities


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)

Program id

Required
showHidden (boolean)

Option to return hidden items.

Default value is False

Optional
showCancelled (boolean)

Option to also return cancelled items.

Default value is False

Optional
showOccurrences (boolean)

Option to show the full list of activity occurrences.

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
CODE SAMPLE JSON
[
  {
    "Description": "Soccer outdoors on Fridays 16h-17h",
    "Prerequisite": "Must have passed soccer I",
    "Note": "Bring snacks, tie your hair, no jewelry",
    "ThirdPartyUrl": "merch/soccer",
    "AdditionalInformation": "Bring more snacks",
    "Price": 0.0,
    "DropInPrice": 0.0,
    "Age": {
      "Max": 17,
      "Min": 7,
      "Months": false
    },
    "MaxAttendance": 24,
    "SpotsRemaining": 2,
    "SpotsReserved": 7,
    "NumberOfOccurrences": 0,
    "StartDate": "2020-01-18T00:00:00-05:00",
    "EndDate": "2020-01-18T00:00:00-05:00",
    "ScheduleSummary": "Fridays 16h-17h, 2 May to 27 August",
    "HasSessionEnabled": false,
    "HasDropInEnabled": false,
    "AgeSummary": "7-17",
    "Keywords": [
      {
        "Id": 88,
        "Name": "Soccer"
      }
    ],
    "Groups": [
      {
        "Id": 3,
        "Name": "Melanie"
      },
      {
        "Id": 4,
        "Name": "Doris"
      }
    ],
    "OrganizationId": 0,
    "PictureUrl": "activity/picture.jpg",
    "Id": 0,
    "Name": "Soccer II",
    "ProgramId": 0,
    "ProgramName": "Summer 2019",
    "CategoryId": 56783,
    "CategoryName": "Soccer",
    "SubCategoryId": 56786,
    "SubCategoryName": "",
    "Url": "soccer/2019/fridays",
    "Status": "Normal"
  },
  {
    "Description": "Soccer outdoors on Fridays 16h-17h",
    "Prerequisite": "Must have passed soccer I",
    "Note": "Bring snacks, tie your hair, no jewelry",
    "ThirdPartyUrl": "merch/soccer",
    "AdditionalInformation": "Bring more snacks",
    "Price": 0.0,
    "DropInPrice": 0.0,
    "Age": {
      "Max": 17,
      "Min": 7,
      "Months": false
    },
    "MaxAttendance": 24,
    "SpotsRemaining": 2,
    "SpotsReserved": 7,
    "NumberOfOccurrences": 0,
    "StartDate": "2020-01-18T00:00:00-05:00",
    "EndDate": "2020-01-18T00:00:00-05:00",
    "ScheduleSummary": "Fridays 16h-17h, 2 May to 27 August",
    "HasSessionEnabled": false,
    "HasDropInEnabled": false,
    "AgeSummary": "7-17",
    "Keywords": [
      {
        "Id": 88,
        "Name": "Soccer"
      }
    ],
    "Groups": [
      {
        "Id": 3,
        "Name": "Melanie"
      },
      {
        "Id": 4,
        "Name": "Doris"
      }
    ],
    "OrganizationId": 0,
    "PictureUrl": "activity/picture.jpg",
    "Id": 0,
    "Name": "Soccer II",
    "ProgramId": 0,
    "ProgramName": "Summer 2019",
    "CategoryId": 56783,
    "CategoryName": "Soccer",
    "SubCategoryId": 56786,
    "SubCategoryName": "",
    "Url": "soccer/2019/fridays",
    "Status": "Normal"
  }
]

#

Get persons in a program for an organization

You can get the program id from org/{orgIdentifier}/programs. Returns a list of persons ordered by id, with the option to show their skills, registrations and medical information


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)

Program id

Required
showSkills (boolean)

Option to show relevant skills.

Default value is False

Optional
showRegistrations (boolean)

Option to show the persons who registered.

Default value is False

Optional
showMedicalInfo (boolean)

Option to show the persons' medical information.

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
CODE SAMPLE JSON
[
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-17"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-17",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  },
  {
    "OrganizationId": 77132,
    "AccountId": 818188,
    "AccountOwnerId": 398313,
    "AccountOwnerFirstName": "Mario",
    "AccountOwnerLastName": "Viau",
    "AccountOwnerFullName": "Mario Viau",
    "AccountOwnerEmail": "mario@monadresse.ca",
    "IsArchived": false,
    "Contacts": [
      {
        "Id": 0,
        "FirstName": "Georgette",
        "LastName": "Plouffe",
        "FullName": "Georgette Plouffe",
        "Email": "allo@videotron.ca",
        "Telephone": "514 555 9999",
        "Relationship": "Grandmother",
        "Type": "EmergencyContact"
      }
    ],
    "Skills": [
      {
        "Id": 88,
        "Name": "Rescue",
        "AwardedDate": "2020-01-17"
      }
    ],
    "MedicalInformation": {
      "Allergies": {
        "Nuts": false,
        "Peanuts": false,
        "Eggs": false,
        "InsectSting": false,
        "Seafood": false
      },
      "Sicknesses": {
        "Asthma": false,
        "Incontinence": false,
        "HearingDisorder": false,
        "Diabete": false,
        "Hyperactive": false,
        "Epilepsy": false,
        "VisualDisorder": false,
        "MotorHandicap": false,
        "BehaviorDisorder": false
      },
      "Reactions": "Rash",
      "MedicationDosage": "20 mg",
      "MedicationFrequency": "Twice daily",
      "MedicationOther": "Take with meals",
      "OtherAllergy": "Crab",
      "OtherSickness": "Sea sickness",
      "MedicalStatus": "NoRecord",
      "HasSickness": false,
      "HasAllergy": false
    },
    "JoinDate": "2020-01-17",
    "PictureUrl": "photo_de_maurice.jpg",
    "Id": 0,
    "FirstName": "Maurice",
    "LastName": "Maynard",
    "FullName": "Maurice Maynard",
    "Gender": "Male",
    "DateOfBirth": "0001-01-01",
    "Email": "mau@gmail.com",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "412 des Érables",
      "Address2": "App. 1",
      "City": "Montreal",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "H3G 1A1"
    },
    "Telephone": "514 555 5555",
    "TelephoneMobile": "438 555 0000",
    "TelephoneWork": "438 555 5555",
    "TelephoneWorkExtension": "1234",
    "IsChild": false
  }
]

#

Get a program for an organization

You can get the program id from org/{orgIdentifier}/programs


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)

Program id

Required
CODE SAMPLE JSON
{
  "Id": 0,
  "Name": "Summer 2019",
  "Start": "0001-01-01T00:00:00-05:00",
  "End": "9999-12-31T18:59:59.9999999-05:00",
  "Url": "www.acme.com/summer2019",
  "PictureUrl": "img/summer2019.jpg",
  "IsArchived": false,
  "IsVisible": false
}

RentalContracts

#

Get the rental contracts for an organization

Returns a list of rental contracts ordered by id, with the option to show archived contracts and to filter by contract status


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

Possible values are 'All', 'Approved', 'Draft', and 'PendingApproval'. These values are case-insensitive.

Default value is All

Optional
showArchived (boolean)

Option to also show archived items.

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
CODE SAMPLE JSON
[
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:23.4148914-05:00",
        "End": "2020-01-18T18:42:23.4148914-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  },
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:23.4148914-05:00",
        "End": "2020-01-18T18:42:23.4148914-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  }
]

#

Get a rental contract for an organization

You can get the rental contract id from /org/{orgIdentifier}/rentalcontracts


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)

Rental contract id

Required
CODE SAMPLE JSON
[
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:23.4148914-05:00",
        "End": "2020-01-18T18:42:23.4148914-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  },
  {
    "OrganizationId": 0,
    "ContractNumber": 0,
    "Name": "August 2019 - Grantham Soccer League & Town of Grantham",
    "ClientId": 75712,
    "AccountId": 921129,
    "Bookings": [
      {
        "Id": 0,
        "LocationId": 0,
        "LocationName": "Grantham soccer field 1",
        "Start": "2020-01-18T18:42:23.4148914-05:00",
        "End": "2020-01-18T18:42:23.4148914-05:00",
        "Price": 0.0,
        "Status": "Tentative"
      }
    ],
    "DateCreated": "2020-01-18",
    "Status": "PendingApproval",
    "Notes": "Subject to conditions",
    "IsArchived": false,
    "Id": 0,
    "AdminNotes": "Refer to agreement"
  }
]

Reservation

#

Get reservations for an organization

Returns a list of reservations ordered by id, with the option to specify start and end dates.


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
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

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
CODE SAMPLE JSON
[
  {
    "Title": "Soccer field 1 for Team Bob",
    "Type": "RentalContract",
    "Start": "2020-01-18T18:42:23.5580244-05:00",
    "End": "2020-01-18T22:42:23.5580244-05:00",
    "AllDay": false,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 avenue des Ormes",
        "Address2": "",
        "City": "Boucherville",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J4B 7J3"
      },
      "Id": 871178,
      "Name": "Soccer field 1"
    },
    "BookingType": {
      "Id": 754457,
      "Name": "AAA",
      "Color": "Yellow"
    },
    "AdminBooking": {
      "Id": 0,
      "Name": null,
      "Description": null
    },
    "Activity": {
      "Description": "Outdoors soccer",
      "Prerequisite": "Must have passed soccer I",
      "Note": "Bring snacks, tie your hair, no jewelry",
      "ThirdPartyUrl": "merch/soccer",
      "AdditionalInformation": "Bring more snacks",
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Age": {
        "Max": 99,
        "Min": 18,
        "Months": false
      },
      "MaxAttendance": 24,
      "SpotsRemaining": 2,
      "SpotsReserved": 7,
      "NumberOfOccurrences": 0,
      "StartDate": "2020-01-18T00:00:00-05:00",
      "EndDate": "2020-01-18T00:00:00-05:00",
      "ScheduleSummary": "Fridays afternoon, 2 May - 27 August",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "18-99",
      "Keywords": [
        {
          "Id": 88,
          "Name": "Soccer"
        }
      ],
      "Groups": [
        {
          "Id": 3,
          "Name": "Melanie"
        },
        {
          "Id": 4,
          "Name": "Doris"
        }
      ],
      "OrganizationId": 0,
      "PictureUrl": "activity/picture.jpg",
      "Id": 0,
      "Name": "Soccer II",
      "ProgramId": 0,
      "ProgramName": "Summer 2019",
      "CategoryId": 56783,
      "CategoryName": "Soccer",
      "SubCategoryId": 56786,
      "SubCategoryName": "",
      "Url": "soccer/2019/fridays",
      "Status": "Normal"
    },
    "Contract": {
      "Id": 888,
      "AdminNotes": "See Chantal"
    },
    "Client": {
      "Id": 0,
      "FirstName": "Andre",
      "LastName": "Gauthier",
      "FullName": "Andre Gauthier",
      "Gender": "Male",
      "DateOfBirth": "1982-01-18",
      "Email": "agauthier@mymail.com",
      "Address": {
        "Latitude": -73.4717,
        "Longitude": 45.4006,
        "Address1": "650 Boul. Taschereau",
        "Address2": "App. 8",
        "City": "La Prairie",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J5R 1V6"
      },
      "Telephone": "450 555 5555",
      "TelephoneMobile": "438 555 5555",
      "TelephoneWork": "514 555 5555",
      "TelephoneWorkExtension": "333",
      "IsChild": false
    }
  },
  {
    "Title": "Soccer field 1 for Team Bob",
    "Type": "RentalContract",
    "Start": "2020-01-18T18:42:23.5580244-05:00",
    "End": "2020-01-18T22:42:23.5580244-05:00",
    "AllDay": false,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 avenue des Ormes",
        "Address2": "",
        "City": "Boucherville",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J4B 7J3"
      },
      "Id": 871178,
      "Name": "Soccer field 1"
    },
    "BookingType": {
      "Id": 754457,
      "Name": "AAA",
      "Color": "Yellow"
    },
    "AdminBooking": {
      "Id": 0,
      "Name": null,
      "Description": null
    },
    "Activity": {
      "Description": "Outdoors soccer",
      "Prerequisite": "Must have passed soccer I",
      "Note": "Bring snacks, tie your hair, no jewelry",
      "ThirdPartyUrl": "merch/soccer",
      "AdditionalInformation": "Bring more snacks",
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Age": {
        "Max": 99,
        "Min": 18,
        "Months": false
      },
      "MaxAttendance": 24,
      "SpotsRemaining": 2,
      "SpotsReserved": 7,
      "NumberOfOccurrences": 0,
      "StartDate": "2020-01-18T00:00:00-05:00",
      "EndDate": "2020-01-18T00:00:00-05:00",
      "ScheduleSummary": "Fridays afternoon, 2 May - 27 August",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "18-99",
      "Keywords": [
        {
          "Id": 88,
          "Name": "Soccer"
        }
      ],
      "Groups": [
        {
          "Id": 3,
          "Name": "Melanie"
        },
        {
          "Id": 4,
          "Name": "Doris"
        }
      ],
      "OrganizationId": 0,
      "PictureUrl": "activity/picture.jpg",
      "Id": 0,
      "Name": "Soccer II",
      "ProgramId": 0,
      "ProgramName": "Summer 2019",
      "CategoryId": 56783,
      "CategoryName": "Soccer",
      "SubCategoryId": 56786,
      "SubCategoryName": "",
      "Url": "soccer/2019/fridays",
      "Status": "Normal"
    },
    "Contract": {
      "Id": 888,
      "AdminNotes": "See Chantal"
    },
    "Client": {
      "Id": 0,
      "FirstName": "Andre",
      "LastName": "Gauthier",
      "FullName": "Andre Gauthier",
      "Gender": "Male",
      "DateOfBirth": "1982-01-18",
      "Email": "agauthier@mymail.com",
      "Address": {
        "Latitude": -73.4717,
        "Longitude": 45.4006,
        "Address1": "650 Boul. Taschereau",
        "Address2": "App. 8",
        "City": "La Prairie",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J5R 1V6"
      },
      "Telephone": "450 555 5555",
      "TelephoneMobile": "438 555 5555",
      "TelephoneWork": "514 555 5555",
      "TelephoneWorkExtension": "333",
      "IsChild": false
    }
  }
]

#

Get reservations for a location in an organization


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)

Location id

Required
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

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
CODE SAMPLE JSON
[
  {
    "Title": "Soccer field 1 for Team Bob",
    "Type": "RentalContract",
    "Start": "2020-01-18T18:42:23.5892713-05:00",
    "End": "2020-01-18T22:42:23.5892713-05:00",
    "AllDay": false,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 avenue des Ormes",
        "Address2": "",
        "City": "Boucherville",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J4B 7J3"
      },
      "Id": 871178,
      "Name": "Soccer field 1"
    },
    "BookingType": {
      "Id": 754457,
      "Name": "AAA",
      "Color": "Yellow"
    },
    "AdminBooking": {
      "Id": 0,
      "Name": null,
      "Description": null
    },
    "Activity": {
      "Description": "Outdoors soccer",
      "Prerequisite": "Must have passed soccer I",
      "Note": "Bring snacks, tie your hair, no jewelry",
      "ThirdPartyUrl": "merch/soccer",
      "AdditionalInformation": "Bring more snacks",
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Age": {
        "Max": 99,
        "Min": 18,
        "Months": false
      },
      "MaxAttendance": 24,
      "SpotsRemaining": 2,
      "SpotsReserved": 7,
      "NumberOfOccurrences": 0,
      "StartDate": "2020-01-18T00:00:00-05:00",
      "EndDate": "2020-01-18T00:00:00-05:00",
      "ScheduleSummary": "Fridays afternoon, 2 May - 27 August",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "18-99",
      "Keywords": [
        {
          "Id": 88,
          "Name": "Soccer"
        }
      ],
      "Groups": [
        {
          "Id": 3,
          "Name": "Melanie"
        },
        {
          "Id": 4,
          "Name": "Doris"
        }
      ],
      "OrganizationId": 0,
      "PictureUrl": "activity/picture.jpg",
      "Id": 0,
      "Name": "Soccer II",
      "ProgramId": 0,
      "ProgramName": "Summer 2019",
      "CategoryId": 56783,
      "CategoryName": "Soccer",
      "SubCategoryId": 56786,
      "SubCategoryName": "",
      "Url": "soccer/2019/fridays",
      "Status": "Normal"
    },
    "Contract": {
      "Id": 888,
      "AdminNotes": "See Chantal"
    },
    "Client": {
      "Id": 0,
      "FirstName": "Andre",
      "LastName": "Gauthier",
      "FullName": "Andre Gauthier",
      "Gender": "Male",
      "DateOfBirth": "1982-01-18",
      "Email": "agauthier@mymail.com",
      "Address": {
        "Latitude": -73.4717,
        "Longitude": 45.4006,
        "Address1": "650 Boul. Taschereau",
        "Address2": "App. 8",
        "City": "La Prairie",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J5R 1V6"
      },
      "Telephone": "450 555 5555",
      "TelephoneMobile": "438 555 5555",
      "TelephoneWork": "514 555 5555",
      "TelephoneWorkExtension": "333",
      "IsChild": false
    }
  },
  {
    "Title": "Soccer field 1 for Team Bob",
    "Type": "RentalContract",
    "Start": "2020-01-18T18:42:23.5892713-05:00",
    "End": "2020-01-18T22:42:23.5892713-05:00",
    "AllDay": false,
    "Location": {
      "Address": {
        "Latitude": 45.72,
        "Longitude": -73.5,
        "Address1": "888 avenue des Ormes",
        "Address2": "",
        "City": "Boucherville",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J4B 7J3"
      },
      "Id": 871178,
      "Name": "Soccer field 1"
    },
    "BookingType": {
      "Id": 754457,
      "Name": "AAA",
      "Color": "Yellow"
    },
    "AdminBooking": {
      "Id": 0,
      "Name": null,
      "Description": null
    },
    "Activity": {
      "Description": "Outdoors soccer",
      "Prerequisite": "Must have passed soccer I",
      "Note": "Bring snacks, tie your hair, no jewelry",
      "ThirdPartyUrl": "merch/soccer",
      "AdditionalInformation": "Bring more snacks",
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Age": {
        "Max": 99,
        "Min": 18,
        "Months": false
      },
      "MaxAttendance": 24,
      "SpotsRemaining": 2,
      "SpotsReserved": 7,
      "NumberOfOccurrences": 0,
      "StartDate": "2020-01-18T00:00:00-05:00",
      "EndDate": "2020-01-18T00:00:00-05:00",
      "ScheduleSummary": "Fridays afternoon, 2 May - 27 August",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "18-99",
      "Keywords": [
        {
          "Id": 88,
          "Name": "Soccer"
        }
      ],
      "Groups": [
        {
          "Id": 3,
          "Name": "Melanie"
        },
        {
          "Id": 4,
          "Name": "Doris"
        }
      ],
      "OrganizationId": 0,
      "PictureUrl": "activity/picture.jpg",
      "Id": 0,
      "Name": "Soccer II",
      "ProgramId": 0,
      "ProgramName": "Summer 2019",
      "CategoryId": 56783,
      "CategoryName": "Soccer",
      "SubCategoryId": 56786,
      "SubCategoryName": "",
      "Url": "soccer/2019/fridays",
      "Status": "Normal"
    },
    "Contract": {
      "Id": 888,
      "AdminNotes": "See Chantal"
    },
    "Client": {
      "Id": 0,
      "FirstName": "Andre",
      "LastName": "Gauthier",
      "FullName": "Andre Gauthier",
      "Gender": "Male",
      "DateOfBirth": "1982-01-18",
      "Email": "agauthier@mymail.com",
      "Address": {
        "Latitude": -73.4717,
        "Longitude": 45.4006,
        "Address1": "650 Boul. Taschereau",
        "Address2": "App. 8",
        "City": "La Prairie",
        "Country": "Canada",
        "StateProvince": "QC",
        "ZipPostalCode": "J5R 1V6"
      },
      "Telephone": "450 555 5555",
      "TelephoneMobile": "438 555 5555",
      "TelephoneWork": "514 555 5555",
      "TelephoneWorkExtension": "333",
      "IsChild": false
    }
  }
]

Staff

#

Get all staff in an organization

Returns a list of staff members ordered by id


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
CODE SAMPLE JSON
[
  {
    "Tags": [
      {
        "Id": 1,
        "Name": "Evening"
      }
    ],
    "Id": 676767,
    "FirstName": "Rosalie",
    "LastName": "Tétreault",
    "FullName": "Rosalie Tétreault",
    "Gender": "Female",
    "DateOfBirth": "2020-01-18",
    "Email": "ro@mymail.ca",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "888 rue des Ormes",
      "Address2": "Appartement A",
      "City": "Longueuil",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "J4J 4J4"
    },
    "Telephone": "450 555 5555",
    "TelephoneMobile": "438 555 5555",
    "TelephoneWork": "514 555 5555",
    "TelephoneWorkExtension": "333"
  },
  {
    "Tags": [
      {
        "Id": 1,
        "Name": "Evening"
      }
    ],
    "Id": 676767,
    "FirstName": "Rosalie",
    "LastName": "Tétreault",
    "FullName": "Rosalie Tétreault",
    "Gender": "Female",
    "DateOfBirth": "2020-01-18",
    "Email": "ro@mymail.ca",
    "Address": {
      "Latitude": 45.72,
      "Longitude": -73.5,
      "Address1": "888 rue des Ormes",
      "Address2": "Appartement A",
      "City": "Longueuil",
      "Country": "Canada",
      "StateProvince": "QC",
      "ZipPostalCode": "J4J 4J4"
    },
    "Telephone": "450 555 5555",
    "TelephoneMobile": "438 555 5555",
    "TelephoneWork": "514 555 5555",
    "TelephoneWorkExtension": "333"
  }
]

#

Get a staff member in an organization

You can get the staff id from /org/{orgIdentifier}/staff


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)

Staff id

Required
CODE SAMPLE JSON
{
  "Tags": [
    {
      "Id": 1,
      "Name": "Evening"
    }
  ],
  "Id": 676767,
  "FirstName": "Rosalie",
  "LastName": "Tétreault",
  "FullName": "Rosalie Tétreault",
  "Gender": "Female",
  "DateOfBirth": "2020-01-18",
  "Email": "ro@mymail.ca",
  "Address": {
    "Latitude": 45.72,
    "Longitude": -73.5,
    "Address1": "888 rue des Ormes",
    "Address2": "Appartement A",
    "City": "Longueuil",
    "Country": "Canada",
    "StateProvince": "QC",
    "ZipPostalCode": "J4J 4J4"
  },
  "Telephone": "450 555 5555",
  "TelephoneMobile": "438 555 5555",
  "TelephoneWork": "514 555 5555",
  "TelephoneWorkExtension": "333"
}

Tags

The tags API allows you to retrieve the list of tags you have defined in Amilia. You can then fetch activities provided a tag. This is useful when you want to group activities in ways not already covered by the program structure. Common tags look like 'Evening' or 'Paula'. Tags can be defined in your Amilia Account under Tags and then attached to your activities.

#

Get tags

Returns all the tags that have been defined for your organization


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
CODE SAMPLE JSON
[
  {
    "Id": 4,
    "Name": "Soccer",
    "Color": "Orange",
    "IsVisible": true
  },
  {
    "Id": 4,
    "Name": "Soccer",
    "Color": "Orange",
    "IsVisible": true
  }
]

#

Get a tag

You can get the tag id from /org/{orgIdentifier}/tags


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)

Tag id

Required
CODE SAMPLE JSON
{
  "Id": 4,
  "Name": "Soccer",
  "Color": "Orange",
  "IsVisible": true
}