The highest level in the hierarchy of assets within the OnSched architecture. Within a company you may have as many Regions and Locations as you need to accommodate the structure of your business model.
Consumer API Interface
The Consumer API Interface is where all of the endpoints that deal directly with end user booking requirements. For example, in the Consumer API Interface you can make GET requests to fetch Locations, Services and Resources in order to allow the user to make selections of each and then be given availability options.
An Event is a type of Service that needs to have event Allocations added in order to show availability. An event Allocation can be created on a one-off basis, or repeated daily/weekly/monthly. These Allocation also have a booking limit which sets the number of bookings that you would like to allow into this event before it becomes unavailable. Allocations must be created within the weekly availability of the Location Resource and Service. Services with a type of Event will not show any availability until an Allocation is created.
The second highest level in the hierarchy of assets, a Location is where an appointment is booked. This could be a physical location, such as Pharmacy or Hair Salon, or an auxiliary Location such as the client or child company of yours. Every Company must have at least one Location
This location will serve as the default for all assets within that are created. This includes Services which can span across all secondary Locations, and settings/notifications that will act as the default for all secondary Locations.
A region is a collection of locations. Similar to Resource Groups this is a way to categorize your locations by physical region or type. Regions are optional and only used to resolve certain use cases.
A Resource is a person (such as a sales representative or pharmacist), place (such as a room or space) or asset (such as a salon chair or desk) that will be booked.
The Sandbox environment is a place for you to build and test without affecting clients that are live in production.
A Service is what is being booked. This includes a name, short description of the service, and its duration settings. There are two types of Services that can be created, a type of Appointment or a type of Event.
Setup API Interface
An OnSched User or "team member" is someone who has access to the Dashboard for development purposes. Your clients and employees (I.e. Resources) that simply need to keep their availability updated will not need access to the Dashboard to do so. Instead, this can be done within your own application via our Setup API Interface or via the OnSchedJs Resource Setup Element.
Updated 12 months ago