Glossary
The following terms have a special meaning in the WellnessLiving SDK. Where applicable, links to definitions in the WellnessLiving Support Knowledge Base have been provided.
| Term | Definition |
| API | The Application Program Interface. WellnessLiving has a RESTful API that can be accessed by using our SDK. |
| Appointment | An appointment is a one-on-one service between a client and a staff member. Typically, the client can choose the time, location, and staff member from those available. Some appointments allow multiple clients to participate. |
| Business | In WellnessLiving, a business refers to a customer. |
| Class | A class is a series of sessions offered by a business and led by at least one staff member. The business selects the time, location, and staff member for each class. Clients can “drop in” and attend any available class. Unlike events, clients aren’t expected to attend every session of a class. |
| Class period | For classes scheduled to recur, a class period refers to the time and day of the week at which the class will occur. Class periods also include a date range specifying the time from when a class first becomes available to when it’s no longer offered. If the end date is ‘0000-00-00’, then the class will continue to be offered indefinitely at that time and day of the week. |
| Client | In WellnessLiving, a client refers to a customer of a business. A client can belong to more than one business. In such cases, the same profile information will be shared between businesses. |
| Customer | In WellnessLiving, a customer refers to a business. For more information, see Business. |
| Endpoint | An endpoint is a file used by the API to receive requests about a specific resource on the server. The SDK connects to the API by connecting to different endpoints. Each endpoint handles a specified task, such as viewing or updating client profile data. |
| Event | An event is a self-contained series of sessions offered by a business and led by at least one staff member. Throughout an event, clients are expected to pay for the entire series of sessions in advance and attend every scheduled session in chronological order. |
| GMT | Greenwich Mean Time. GMT is used in places as a synonym for UTC (Coordinated Universal Time). Time zones are usually described by their offset from UTC. |
| Location | In WellnessLiving, a location refers to the physical location of a business. Note that a business can have multiple associated locations. |
| Membership | A membership is a Purchase Option that allows a client to attend selected services for a given length of time. For example, a client can use a three-month membership to attend a class for three months. |
| Pass | A pass (also referred to as a session pass) is a Purchase Option that allows a client to attend selected services a given number of times. For example, a client can purchase a pass permitting them to attend 10 appointments. |
| Promotion | A promotion is another name for a Purchase Option. |
| Purchase Option | A Purchase Option is something used by a client to pay for a service. Passes and memberships are both examples of Purchase Options. Clients may also be able to book a single session with a drop-in rate. For the purposes of the SDK, the purchase of a drop-in session counts as a Purchase Option. |
| SDK | Software Development Kit. The SDK is premade code that helps connect external developers to the WellnessLiving system. |
| Service | In WellnessLiving, a service refers to a class, event, or appointment. |
| Session | A session is an instance of a service with a specific date, time, and location. For example, a class scheduled to occur every weeknight at 6:00 PM each week would consist of five sessions per week. |
| Staff member | A staff member is an employee of a business. Based on their assigned role, a staff member will have different privileges that determine what actions they’re permitted to perform in the system. |
| UTC | Coordinated Universal Time. This is synonymous with GMT. Time zones are usually described by their offset from UTC. |
| Visit | In WellnessLiving, a visit refers to a single session attended by a client. |