Glossary
Meaning of the terms used in our API, grouped by section
Activities
In Amilia an activity is a class or specific offering, for example Yoga Tuesdays at 7PM. Other systems may call this a program. In Amilia a program is a container of similar activities, for example Adult classes winter 2019.
-
Attendance
Number of people present at an activity
-
Drop-in
Activity on an optional, per-class basis
-
Event
A unique activity time unit that may or may not be part of a series. Also called occurrence
-
Occurrence
A unique activity time unit that may or may not be part of a series. Also called event
-
Program
Set of activities organized in a hierarchy. On top of Category (if any), SubCategory (if any), and Activities
-
Session
A determined number of activity occurrences within a given time limit
Events / occurrences
An event / occurrence is an activity unit in a unique time slot. The words event and occurrence are used interchangeably in our platform, so an event / occurrence may or may not be part of a series.
Keywords
Keywords summarize specific types of activities, such as 'soccer' or 'yoga'. Compare to Activity which typically looks like 'Soccer Friday 15h-16h'. Keywords are also related to verticals (areas of business), except that where verticals can be as general as gymnastics or camp, keywords tend to be more specific.
Locations (facilities)
N.B.: The term 'facilities' is deprecated and has been replaced by 'locations'.
-
Ancestor
In the location hierarchy, any location above a given location
-
Parent
In the location hierarchy, the location immediately above a given location
-
Top parent
In the location hierarchy, the location at the top
Participants (attendance)
Participants are the persons who were present at an activity event / occurrence.
N.B.: The term 'attendance' is deprecated and has been replaced by 'participants' in v3.
Programs
A program is a set of activities organized in a hierarchy like so: program > category > subcategory > activities.
-
Category
In the program hierarchy, immediately under Program and above SubCategory
-
Program
Set of activities organized in a hierarchy. On top of Category (if any), SubCategory (if any), and Activities
-
Subcategory
In the program hierarchy, immediately under Category and above Activities
Rental contracts
Rental contracts are created to allow locations (facilities) to be rented out.
Reservations
Reservations are related to locations (facilities) and can also be related to rental contracts.