Skip to main content

TargetTour

Represents a whole active tour with multiple work items

type TargetTour implements Tour {
  abbreviation: String!
  accompanyingEmployee: Employee
  activeTour: ActiveTour
  backgroundColor: String!
  canBeDeleted: Boolean!
  date: Date!
  employee: Employee
  endPoint: TourStartLocation!
  endTime: Time
  entries(
    timeOfDay: TimeOfDayType
  ): [TourEntry!]!
  estimatedEnd: Time
  fontColor: String!
  hasExternalClients: Boolean!
  id: TargetTourID!
  legs: [RouteLeg!]!
  lendingRequest: LendingRequest
  maxWorkTime: Int!
  name: String!
  preferredCareTeams: [CareTeam!]
  residentialPark: ResidentialPark!
  route: String
  sourceTemplateId: ShiftPlanTemplateID
  startTime: Time!
  startingPoint: TourStartLocation!
  status: TargetTourStatus!
  timeBlock: TimeBlock!
  totalValue: Int!
  type: TourType!
  vehicle: Vehicle
}

Fields​

TargetTour.abbreviation ● String! non-null scalar​

Abbreviation of the tour name.

TargetTour.accompanyingEmployee ● Employee object​

The accompanying employee assigned to this tour. (Optional)

TargetTour.activeTour ● ActiveTour object​

The active tour corresponding to the given target tour

TargetTour.backgroundColor ● String! non-null scalar​

The background color of the tour.

TargetTour.canBeDeleted ● Boolean! non-null scalar​

Shows if the target tour can be deleted or not

TargetTour.date ● Date! non-null scalar​

The date of the given tour

TargetTour.employee ● Employee object​

The employee assigned to this tour. Returns null, if there is no employee assigned yet.

TargetTour.endPoint ● TourStartLocation! non-null enum​

The place this tour should end

TargetTour.endTime ● Time scalar​

The end time of the tour as defined in the tour templates.

TargetTour.entries ● [TourEntry!]! non-null interface​

The list of all entries to the given target tour

TargetTour.entries.timeOfDay ● TimeOfDayType enum​

Optional filter to fetch only the work items for the given time of the day.

TargetTour.estimatedEnd ● Time scalar​

The estimated end of the tour. Returns null if the end of this tour is not yet estimated.

TargetTour.fontColor ● String! non-null scalar​

The color of the tour.

TargetTour.hasExternalClients ● Boolean! non-null scalar​

Returns true if there are any external clients within this tour.

TargetTour.id ● TargetTourID! non-null scalar​

The unique identifier

TargetTour.legs ● [RouteLeg!]! non-null object​

A list of routing legs for the entries. Always have n+1 number of legs. If two locations are at the same point the duration for the leg is 0.

TargetTour.lendingRequest ● LendingRequest object​

The open, offered or accepted lending request of this tour, if any.

TargetTour.maxWorkTime ● Int! non-null scalar​

The max total work time for the tour.

TargetTour.name ● String! non-null scalar​

The name of the given tour

TargetTour.preferredCareTeams ● [CareTeam!] list object​

All unique care teams that the clients in this tour belong to. They serve as preferred care teams when assigning employees to the tour.

TargetTour.residentialPark ● ResidentialPark! non-null object​

The park this tour is assigned to.

TargetTour.route ● String scalar​

The routed path for this tour.

TargetTour.sourceTemplateId ● ShiftPlanTemplateID scalar​

The Tour Template this tour was generated from, if any (null for manually created tours).

TargetTour.startTime ● Time! non-null scalar​

The time this tour should start.

TargetTour.startingPoint ● TourStartLocation! non-null enum​

The place this tour should start

TargetTour.status ● TargetTourStatus! non-null enum​

Shows if the given tour has been published

TargetTour.timeBlock ● TimeBlock! non-null enum​

The time block when the tour is taking place

TargetTour.totalValue ● Int! non-null scalar​

Sum of the reference values of all tour work items.

TargetTour.type ● TourType! non-null enum​

Shows the type of the tour

TargetTour.vehicle ● Vehicle object​

The vehicle used for this tour. If null the tour is performed by foot. A tour routed by car, bike or scooter without a specific fleet vehicle returns a placeholder vehicle of that category.

Interfaces​

Tour interface​

Represents the active and target tour objects

Returned By​

addEmptyTour mutation ● targetTour query ● targetTours query ● updateTourWithTemplateValues mutation

Member Of​

AcceptLendingOfferPayload object ● ActiveTour object ● ActivityEntry object ● AddBenefitsToTourEntryPayload object ● CancelLendingPayload object ● CancelLendingRequestPayload object ● ClientPoolEntry object ● CommentReportCard object ● ContractDetails object ● CreateLendingRequestPayload object ● Employee object ● FillActivityEntryPayload object ● LendingAssignment object ● LendingRequest object ● PerformanceReportDetails object ● ReportCard interface ● ReportSheetReportCard object ● SingleClientEntry object ● SisReportCard object ● TourEntry interface ● TourPlan object ● TourShiftElement object ● VitalSignReportCard object