getOnSiteJobsAppointmentByExternalReference

Get appointment by external reference and agent.

Arguments

agent : OnSiteJobsAgent!


            required

The agent for the appointment.

externalReference : String!


            required

The external reference of the appointment to return.

Returns

OnSiteJobsAppointmentType

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

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.

query GetOnSiteJobsAppointmentByExternalReference(
  $agent: OnSiteJobsAgent!,
  $externalReference: String!
) {
  getOnSiteJobsAppointmentByExternalReference(
    agent: $agent,
    externalReference: $externalReference
  ) {
    agent
    appointmentActions {
      ...OnSiteJobsAppointmentActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    cancellationCategory
    cancellationSubCategory
    cancelledAt
    comments
    commsStrategy
    createdAt
    deadlineDate
    endAt
    externalJobTypeMapping {
      ...OnSiteJobsExternalJobTypeMappingTypeFragment
    }
    externalReference
    id
    jobDetails
    jobNotes
    krakenWorkCategory
    preferredStartDate
    request {
      ...OnSiteJobsRequestTypeFragment
    }
    startAt
    status
  }
}

{
  "agent": "GENERIC_AGENT",
  "externalReference": "born-position-special-production-involve"
}

{
  "data": {
    "getOnSiteJobsAppointmentByExternalReference": {
      "agent": "GENERIC_AGENT",
      "appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "cancellationCategory": "CANCELLED_BY_CUSTOMER",
      "cancellationSubCategory": "success-sell-police-boy-determine",
      "cancelledAt": "2004-04-08T06:56:24.919703+00:00",
      "comments": "poor-wind-until-join-six",
      "commsStrategy": "SEND_ALL",
      "createdAt": "1973-01-25T08:13:11.138311+00:00",
      "deadlineDate": "2003-10-11",
      "endAt": "1999-02-04T06:14:18.478094+00:00",
      "externalJobTypeMapping": OnSiteJobsExternalJobTypeMappingType,
      "externalReference": "clear-factor-answer-this-design",
      "id": "bb52af4f-6c45-405b-8fd1-f298ac24ccc7",
      "jobDetails": {"key": "value"},
      "jobNotes": {"key": "value"},
      "krakenWorkCategory": "ACCURACY_TEST",
      "preferredStartDate": "2010-07-03",
      "request": OnSiteJobsRequestType,
      "startAt": "1971-03-11T19:25:23.108472+00:00",
      "status": "REQUIRES_TIMESLOT"
    }
  }
}