Appointments

List Attendance Appointments

Changed on

Retrieve 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.

get/locations/{location_id}/attendances/{attendance_id}/appointments

Request

  • Base URL
    https://api.alteg.io/api/v2
  • Auth
    HTTP bearer

Path parameters

location_idinteger required

Location ID

attendance_idstring required
Example:record_12345

Attendance group identifier. Use the literal record_ prefix with an Appointment ID or the literal visit_ prefix with a visit ID.

Query parameters

includestring[]

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

Acceptstring required

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Authorizationstring required

Bearer {partner_token}, User {user_token}

Response

Attendance Appointments retrieved successfully

Changes

    • info

      added the enum value attendance_good_items.good to the property items/ of the query request parameter include

    • info

      added the enum value attendance_good_items.loyalty_abonement to the property items/ of the query request parameter include

    • info

      added the enum value attendance_good_items.loyalty_certificate to the property items/ of the query request parameter include

    • info

      added the enum value attendance_good_items.marks to the property items/ of the query request parameter include

    • info

      added the enum value attendance_good_items.staff to the property items/ of the query request parameter include

    • info

      added the enum value attendance_service_items.assistants to the property items/ of the query request parameter include

    • info

      added the enum value attendance_service_items.attendance_service_composite.composite_service to the property items/ of the query request parameter include

    • info

      response property data/items/attributes/master_id deprecated