startOnSiteJobsAppointmentBookingSession

Start the appointment booking process.

Arguments

appointmentBookingDetails : OnSiteJobsAppointmentBookingDetailsInput!


            required

The appointment booking details.

overrideAppointmentCheckWarnings : Boolean

Whether to override appointment booking check warnings. Defaults to False.

overrideRequestCheckWarnings : Boolean

Whether to override request creation check warnings. Defaults to False.

requestBookingDetails : OnSiteJobsRequestBookingDetailsInput!


            required

The request booking details.

Returns

StartOnSiteJobsAppointmentBookingSession

Start the appointment booking process.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can create on site jobs appointments AND Can create on site jobs requests

Query Complexity

Examples

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 StartOnSiteJobsAppointmentBookingSession(
  $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
  $overrideAppointmentCheckWarnings: Boolean,
  $overrideRequestCheckWarnings: Boolean,
  $requestBookingDetails: OnSiteJobsRequestBookingDetailsInput!
) {
  startOnSiteJobsAppointmentBookingSession(
    appointmentBookingDetails: $appointmentBookingDetails,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
    overrideRequestCheckWarnings: $overrideRequestCheckWarnings,
    requestBookingDetails: $requestBookingDetails
  ) {
    appointmentBookingSessionId
  }
}

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "overrideAppointmentCheckWarnings": true,
  "overrideRequestCheckWarnings": true,
  "requestBookingDetails": OnSiteJobsRequestBookingDetailsInput
}

{
  "data": {
    "startOnSiteJobsAppointmentBookingSession": {
      "appointmentBookingSessionId": "a55361fd-a88d-4a76-bdc1-599c101c417f"
    }
  }
}