getOnSiteJobsCheckResults

Get check results for creating requests and appointments.

Arguments

jobType : String

Job type for appointment checks.

supplyPointIdentifierToMarketNameMapping : [SupplyPointIdentifierToMarketNameMappingInput]

Supply point identifier to market name mapping. If this is provided, supplyPointInternalIds cannot be provided. Either one of them must be provided.

supplyPointInternalIds : [Int]

List of internal IDs of supply points. If this is provided, supplyPointIdentifierToMarketNameMapping cannot be provided. Either one of them must be provided.

Returns

OnSiteJobsCheckResultsType

Check results for creating On-Site Jobs requests and appointments.

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 GetOnSiteJobsCheckResults(
  $jobType: String,
  $supplyPointIdentifierToMarketNameMapping: [SupplyPointIdentifierToMarketNameMappingInput],
  $supplyPointInternalIds: [Int]
) {
  getOnSiteJobsCheckResults(
    jobType: $jobType,
    supplyPointIdentifierToMarketNameMapping: $supplyPointIdentifierToMarketNameMapping,
    supplyPointInternalIds: $supplyPointInternalIds
  ) {
    appointmentCheckResults {
      ...CheckResultTypeFragment
    }
    canCreateAppointment
    canCreateRequest
    hasAppointmentWarnings
    hasRequestWarnings
    requestCheckResults {
      ...CheckResultTypeFragment
    }
  }
}

{
  "jobType": "another-western-power-save-hand",
  "supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput,
  "supplyPointInternalIds": 46
}

{
  "data": {
    "getOnSiteJobsCheckResults": {
      "appointmentCheckResults": [CheckResultType],
      "canCreateAppointment": true,
      "canCreateRequest": true,
      "hasAppointmentWarnings": true,
      "hasRequestWarnings": true,
      "requestCheckResults": [CheckResultType]
    }
  }
}