Skip to main content

Tour

Represents the active and target tour objects

interface Tour {
  abbreviation: String!
  accompanyingEmployee: Employee
  backgroundColor: String!
  date: Date!
  employee: Employee
  endPoint: TourStartLocation!
  endTime: Time
  estimatedEnd: Time
  fontColor: String!
  hasExternalClients: Boolean!
  maxWorkTime: Int!
  name: String!
  residentialPark: ResidentialPark!
  route: String
  startTime: Time!
  startingPoint: TourStartLocation!
  timeBlock: TimeBlock!
  totalValue: Int!
  type: TourType!
  vehicle: Vehicle
}

Fields​

Tour.abbreviation ● String! non-null scalar​

Abbreviation of the tour name.

Tour.accompanyingEmployee ● Employee object​

The accompanying employee assigned to this tour. (Optional)

Tour.backgroundColor ● String! non-null scalar​

The background color of the tour.

Tour.date ● Date! non-null scalar​

The date of the given tour

Tour.employee ● Employee object​

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

Tour.endPoint ● TourStartLocation! non-null enum​

The place this tour should end

Tour.endTime ● Time scalar​

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

Tour.estimatedEnd ● Time scalar​

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

Tour.fontColor ● String! non-null scalar​

The color of the tour.

Tour.hasExternalClients ● Boolean! non-null scalar​

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

Tour.maxWorkTime ● Int! non-null scalar​

The max total work time for the tour.

Tour.name ● String! non-null scalar​

The name of the given tour

Tour.residentialPark ● ResidentialPark! non-null object​

The park this tour is assigned to.

Tour.route ● String scalar​

The routed path for this tour.

Tour.startTime ● Time! non-null scalar​

The time this tour should start.

Tour.startingPoint ● TourStartLocation! non-null enum​

The place this tour should start

Tour.timeBlock ● TimeBlock! non-null enum​

The time block when the tour is taking place

Tour.totalValue ● Int! non-null scalar​

Sum of the reference values of all tour work items.

Tour.type ● TourType! non-null enum​

Shows the type of the tour

Tour.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.

Implemented By​

ActiveTour object ● TargetTour object