Skip to main content

ClientPoolWorkItem

Subtype of tour work item, representing a single benefit and all clients that have it

type ClientPoolWorkItem implements TourWorkItem, WorkItem {
benefit: Benefit!
clients: [ClientWorkItem!]!
comments: [Comment!]!
description: String
deviations: [Deviation!]!
estimatedEnd: Time
estimatedStart: Time
id: TourWorkItemID!
isReference: Boolean
location: Geolocation
origin: TourEntry
reason: String
referenceValue: Int!
state: WorkItemState!
timeOfDay: TimeOfDayType!
tour: ActiveTour!
}

Fields

ClientPoolWorkItem.benefit ● Benefit! non-null interface

The benefit responsible for the tour

ClientPoolWorkItem.clients ● [ClientWorkItem!]! non-null object

The corresponding clients

ClientPoolWorkItem.comments ● [Comment!]! non-null object

List of additional comments by the employees.

ClientPoolWorkItem.description ● String scalar

Optional description made by a PDL.

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

Shows all possible deviations, if available

ClientPoolWorkItem.estimatedEnd ● Time scalar

Estimated end time

ClientPoolWorkItem.estimatedStart ● Time scalar

Estimated start time

ClientPoolWorkItem.id ● TourWorkItemID! non-null scalar

The unique identifier

ClientPoolWorkItem.isReference ● Boolean scalar

Shows if the object is the original work item, or a reference to it

ClientPoolWorkItem.location ● Geolocation object

The location of this entry

ClientPoolWorkItem.origin ● TourEntry interface

Connection to the original tour entry (source).

ClientPoolWorkItem.reason ● String scalar

Reason why this work item is rejected. Only available if state is REJECTED.

ClientPoolWorkItem.referenceValue ● Int! non-null scalar

Reference value of the Benefit in minutes, up to 3 digits. Shows the average execution time of the Benefit

ClientPoolWorkItem.state ● WorkItemState! non-null enum

Current state of the work item.

ClientPoolWorkItem.timeOfDay ● TimeOfDayType! non-null enum

The time of the day this work items is planned for.

ClientPoolWorkItem.tour ● ActiveTour! non-null object

The tour this work item belongs to.

Interfaces

TourWorkItem interface

Represents a single tour work item

WorkItem interface

Work items are tasks an employee can perform during his shift.

Currently it's implemented by

  • ActivityWorkItem
  • ClientPoolWorkItem
  • SingleClientWorkItem which have the following sub tasks:
  • BenefitWorkItem
  • ClientWorkItem