Fields

agent : SiteworksAppointmentAgent

The agent carrying out the appointment.
agentReference : String

The agent reference of the appointment.
appointmentDate : Date

The date of the appointment.
cancellationCategory : CancellationCategory

The reason the appointment was cancelled (category).
cancellationSubCategory : String

The reason the appointment was cancelled (sub-category).
createdAt : DateTime! required

When the appointment was created.
date : Date

The date of the appointment.
id : UUID! required

The unique identifier of the appointment.
requestId : String

The request ID of the Request that the appointment is associated with.
status : AppointmentStatus

The current status of the Siteworks application.
timeSlotEnd : Time

The end time of the appointment time slot.
timeSlotStart : Time

The start time of the appointment time slot.
workCategory : WorkCategory

The category of work the appointment has been booked for.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "agent": "GENERIC_AGENT", "agentReference": "available-term-small-stock-game", "appointmentDate": "2004-10-22", "cancellationCategory": "CANCELLED_BY_CUSTOMER", "cancellationSubCategory": "site-her-number-difference-bank", "createdAt": "1985-02-03T05:23:27.193622+00:00", "date": "2020-05-26", "id": "1d43d1ff-ecd1-445e-88c7-80f6907f9669", "requestId": "71440749", "status": "REQUIRES_TIMESLOT", "timeSlotEnd": "19:30:20.250468", "timeSlotStart": "09:47:57.802208", "workCategory": "ACCURACY_TEST" }