List Attendance Appointments
Changed onRetrieve Appointments grouped under one attendance identifier as JSON:API resource objects.
Use record_{appointment_id} to retrieve the group containing one Appointment, or visit_{visit_id} to retrieve all Appointments linked to one visit. The attendance_id path parameter and both prefixes are literal wire values.
Related data can be requested by repeating the include parameter. Wire values remain literal API keys: client identifies Booking User data, staff identifies Team Member data, and goods identifies Products. Custom Field Value includes require the corresponding Business User permissions.
This is the read for Save Visit Appointments, which replaces whole Appointments. Nested includes such as attendance_good_items.marks, attendance_good_items.loyalty_abonement, attendance_good_items.loyalty_certificate, and attendance_service_items.assistants return the keys that operation requires you to echo.
Request
- Base URLhttps://api.alteg.io/api/v2
- AuthHTTP bearer
Path parameters
Location ID
Attendance group identifier. Use the literal record_ prefix with an Appointment ID or the literal visit_ prefix with a visit ID.
Query parameters
Includes accepted by the attendance operations. They extend the Appointment includes with the nested includes needed to read back every key that Save Visit Appointments requires. Values are literal API keys.
Related resources to include; values are literal API keys
Headers
Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.
Bearer {partner_token}, User {user_token}
Response
Attendance Appointments retrieved successfully
Changes
- info
added the enum value
attendance_good_items.goodto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_good_items.loyalty_abonementto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_good_items.loyalty_certificateto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_good_items.marksto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_good_items.staffto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_service_items.assistantsto the propertyitems/of thequeryrequest parameterinclude - info
added the enum value
attendance_service_items.attendance_service_composite.composite_serviceto the propertyitems/of thequeryrequest parameterinclude
- info
- info
response property
data/items/attributes/master_iddeprecated
- info