TargetTour

Represents a whole active tour with multiple work items

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

Fields

TargetTour.activeTour ● ActiveTour object

The active tour corresponding to the given target 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.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.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.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.residentialPark ● ResidentialPark! non-null object

The park this tour is assigned to.

TargetTour.route ● String scalar

The routed path for this tour.

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.

Interfaces

Tour interface

Represents the active and target tour objects

Returned By

addEmptyTour mutation ● targetTour query ● targetTours query

Member Of

ActiveTour object ● ActivityEntry object ● ClientPoolEntry object ● Employee object ● SingleClientEntry object ● TourEntry interface ● TourShiftElement object