startOnSiteJobsAppointmentBookingSessionForRequest
Start the appointment booking process for an on-site jobs request.
Arguments
The appointment booking details.
Whether to override appointment booking check warnings. Defaults to False.
The ID of the request to book an appointment for.
Returns
StartOnSiteJobsAppointmentBookingSessionForRequestStart the appointment booking process for an on-site jobs request.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13020: Could not identify agent from property.
- KT-CT-13021: Invalid job type.
- KT-CT-13022: Work category not found for job type.
- KT-CT-13023: Appointment booking checks failed.
- KT-CT-13024: Appointment booking checks returned warnings.
- KT-CT-13032: Request does not exist.
- KT-CT-13055: Appointment does not belong to the specified request.
- KT-CT-13073: Job type not available for self-serve booking.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Required Permissions
Can create on site jobs appointmentsQuery Complexity
1Examples
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.
mutation StartOnSiteJobsAppointmentBookingSessionForRequest(
$appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
$overrideAppointmentCheckWarnings: Boolean,
$requestId: UUID!
) {
startOnSiteJobsAppointmentBookingSessionForRequest(
appointmentBookingDetails: $appointmentBookingDetails,
overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
requestId: $requestId
) {
appointmentBookingSessionId
}
}
Variables
{
"appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
"overrideAppointmentCheckWarnings": true,
"requestId": "e8371486-49e2-4959-be3a-eb11da80a3bb"
}
Response
{
"data": {
"startOnSiteJobsAppointmentBookingSessionForRequest": {
"appointmentBookingSessionId": "fed6e014-65be-4202-9044-0b2d397f8974"
}
}
}