Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 4.05 KB

AddClientToClassVisit.md

File metadata and controls

30 lines (26 loc) · 4.05 KB
Raw

AddClientToClassVisit

Properties

Name Type Description Notes
cross_regional_booking_performed bool When `true`, indicates that the client is paying for the visit using a pricing option from one of their associated cross-regional profiles. [optional]
site_id int The ID of the business from which cross-regional payment is applied. [optional]
waitlist_entry_id int When this value is not null, it indicates that the client is on the waiting list for the requested class. The only additional fields that are populated when this is not null are: * ClassId * ClientId You can call GET WaitlistEntries using `WaitlistEntryId` to obtain more data about this waiting list entry. [optional]
appointment_id int The appointment’s ID. [optional]
appointment_gender_preference string The gender of staff member with whom the client prefers to book appointments. [optional]
appointment_status string The status of the appointment. [optional]
class_id int The class ID that was used to retrieve the visits. [optional]
client_id string The ID of the client associated with the visit. [optional]
start_date_time \DateTime The time this class is scheduled to start. [optional]
end_date_time \DateTime The date and time the visit ends. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as “2018-06-25T19:15:00Z” because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ. [optional]
id int The ID of the visit. [optional]
last_modified_date_time \DateTime When included in the request, only records modified on or after the specified `LastModifiedDate` are included in the response. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as “2018-06-25T19:15:00Z” because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ. [optional]
late_cancelled bool When `true`, indicates that the class has been `LateCancelled`.<br /> When `false`, indicates that the class has not been `LateCancelled`. [optional]
location_id int The ID of the location where the visit took place or is to take place. [optional]
make_up bool When `true`, the client can make up this session and a session is not deducted from the pricing option that was used to sign the client into the enrollment. When the client has the make-up session, a session is automatically removed from a pricing option that matches the service category of the enrollment and is within the same date range of the missed session.<br /> When `false`, the client cannot make up this session. See Enrollments: Make-ups for more information. [optional]
name string The name of the class. [optional]
service_id int The ID of the pricing option used to pay for the class visit. [optional]
signed_in bool When `true`, indicates that the client has been signed in.<br /> When `false`, indicates that the client has not been signed in. [optional]
staff_id int The ID of the staff member who is teaching the class. [optional]
web_signup bool When `true`, indicates that the client signed up online.<br /> When `false`, indicates that the client was signed up by a staff member. [optional]
action string The action taken. [optional]

[Back to Model list] [Back to API list] [Back to README]