Skip to main content

Fields

agent : OnSiteJobsAgent

The agent the draft appointment will be booked with.

bookingAm : Boolean

Whether the customer prefers a morning timeslot. Null if not recorded.

bookingComments : String! required

Free-text notes about the customer's timeslot preferences.

bookingFriday : Boolean

Whether the customer prefers a Friday timeslot. Null if not recorded.

bookingMonday : Boolean

Whether the customer prefers a Monday timeslot. Null if not recorded.

bookingPm : Boolean

Whether the customer prefers an afternoon timeslot. Null if not recorded.

bookingThursday : Boolean

Whether the customer prefers a Thursday timeslot. Null if not recorded.

bookingTuesday : Boolean

Whether the customer prefers a Tuesday timeslot. Null if not recorded.

bookingWednesday : Boolean

Whether the customer prefers a Wednesday timeslot. Null if not recorded.

comments : String! required

Comments about the job.

commsStrategy : OnSiteJobsCommsStrategy

The communication strategy for this draft appointment.

createdAt : DateTime! required

When the draft appointment was created.

externalJobTypeMapping : OnSiteJobsExternalJobTypeMappingType! required

The job type the appointment will be booked with.

id : UUID! required

The Kraken ID of the draft appointment.

jobDetails : JSONString! required

Additional details about the job, as required by the agent.

krakenWorkCategory : OnSiteJobsWorkCategory

The work category for this draft appointment.

request : OnSiteJobsRequestType! required

The request this draft appointment was created for.

updatedAt : DateTime! required

When the draft appointment was last updated.

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", "bookingAm": true, "bookingComments": "television-easy-sing-radio-land", "bookingFriday": true, "bookingMonday": true, "bookingPm": true, "bookingThursday": true, "bookingTuesday": true, "bookingWednesday": true, "comments": "involve-economic-keep-Mrs-action", "commsStrategy": "SEND_ALL", "createdAt": "2017-05-12T17:04:31.799680+00:00", "externalJobTypeMapping": OnSiteJobsExternalJobTypeMappingType, "id": "063fa2b6-7c5c-483d-820a-43232be893f4", "jobDetails": {"key": "value"}, "krakenWorkCategory": "ACCURACY_TEST", "request": OnSiteJobsRequestType, "updatedAt": "2014-11-30T14:56:52.234129+00:00" }