createOnSiteJobsAppointmentWithDate
Create an Appointment using DATE booking mode. Used when the booking flow does not require selecting a specific timeslot.
Arguments
The appointment booking details.
The deadline date for the appointment.
Whether to override appointment booking check warnings. Defaults to False.
The preferred date for the appointment.
The ID of the request to book an appointment for.
Returns
CreateOnSiteJobsAppointmentWithDateCreate an Appointment using DATE booking mode. Used when the booking flow does not require selecting a specific timeslot.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13019: Vendor not found.
- 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-13027: Booking system error occurred.
- KT-CT-13028: Agent not found.
- KT-CT-13032: Request does not exist.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13035: Request is inactive.
- KT-CT-13036: Booking service currently unavailable.
- KT-CT-13037: Appointment reference not provided by booking service.
- KT-CT-13057: Date booking mode is not applicable for this request.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- 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 CreateOnSiteJobsAppointmentWithDate(
$appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
$deadlineDate: Date,
$overrideAppointmentCheckWarnings: Boolean,
$preferredDate: Date!,
$requestId: UUID!
) {
createOnSiteJobsAppointmentWithDate(
appointmentBookingDetails: $appointmentBookingDetails,
deadlineDate: $deadlineDate,
overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
preferredDate: $preferredDate,
requestId: $requestId
) {
onSiteJobsAppointment {
...OnSiteJobsAppointmentTypeFragment
}
}
}
Variables
{
"appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
"deadlineDate": "1970-04-24",
"overrideAppointmentCheckWarnings": true,
"preferredDate": "1976-10-16",
"requestId": "fe725a5e-e31e-48fb-8332-ac334d7ab56d"
}
Response
{
"data": {
"createOnSiteJobsAppointmentWithDate": {
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}
}
}