ActiveTour

Represents a whole active tour with multiple work items

type ActiveTour implements Tour {
  autoCompletesAt: LocalDateTime!
  date: Date!
  deviations: [Deviation!]!
  employee: Employee
  endPoint: TourStartLocation!
  estimatedEnd: Time
  hasExternalClients: Boolean!
  id: ActiveTourID!
  legs: [RouteLeg!]!
  maxWorkTime: Int!
  name: String!
  residentialPark: ResidentialPark!
  route: String
  startTime: Time!
  startingPoint: TourStartLocation!
  status: ActiveTourStatus!
  targetTour: TargetTour!
  timeBlock: TimeBlock!
  totalValue: Int!
  type: TourType!
  vehicle: Vehicle
  workItems(
    timeOfDay: TimeOfDayType
  ): [TourWorkItem!]!
}

Fields

ActiveTour.autoCompletesAt ● LocalDateTime! non-null scalar

Shows the time, when the tour is to be automatically completed (and can be edited)

ActiveTour.date ● Date! non-null scalar

The date of the given tour

ActiveTour.deviations ● [Deviation!]! non-null enum

Shows all possible deviations, if available

ActiveTour.employee ● Employee object

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

ActiveTour.endPoint ● TourStartLocation! non-null enum

The place this tour should end

ActiveTour.estimatedEnd ● Time scalar

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

ActiveTour.hasExternalClients ● Boolean! non-null scalar

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

ActiveTour.id ● ActiveTourID! non-null scalar

The unique identifier

ActiveTour.legs ● [RouteLeg!]! non-null object

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

ActiveTour.maxWorkTime ● Int! non-null scalar

The max total work time for the tour.

ActiveTour.name ● String! non-null scalar

The name of the given tour

ActiveTour.residentialPark ● ResidentialPark! non-null object

The park this tour is assigned to.

ActiveTour.route ● String scalar

The routed path for this tour.

ActiveTour.startTime ● Time! non-null scalar

The time this tour should start.

ActiveTour.startingPoint ● TourStartLocation! non-null enum

The place this tour should start

ActiveTour.status ● ActiveTourStatus! non-null enum

Shows if the given tour has been published

ActiveTour.targetTour ● TargetTour! non-null object

The target tour corresponding to the given active tour

ActiveTour.timeBlock ● TimeBlock! non-null enum

The time block when the tour is taking place

ActiveTour.totalValue ● Int! non-null scalar

Sum of the reference values of all tour work items.

ActiveTour.type ● TourType! non-null enum

Shows the type of the tour

ActiveTour.vehicle ● Vehicle object

The vehicle used for this tour. If null the tour is performed by foot.

ActiveTour.workItems ● [TourWorkItem!]! non-null interface

The list of all work items to the given tour

ActiveTour.workItems.timeOfDay ● TimeOfDayType enum

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

Interfaces

Tour interface

Represents the active and target tour objects

Returned By

activeTour query ● activeTours query

Member Of

ActivityWorkItem object ● ClientPoolWorkItem object ● SingleClientWorkItem object ● TargetTour object ● TourWorkItem interface ● User object