Service not started yet but driver and vehicle have arrived at stop.
| No fields defined. |
Specifies a violation that involves a distance limit. This violation has one of the following tour event violation types: MAXIMUM_DISTANCE.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| exceedance | Distance (Double) | no | - | 2.24 | Distance by which the limit is exceeded on the current leg in total. |
The summary of a logbook of a driver. If provided as input, it is taken into account when the mandatory breaks and rests are calculated.
| No fields defined. |
According to Regulation (EC) 561/2006 of the European Union.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| accumulatedDrivingTimeSinceLastBreak | Duration (Double) | no | 0.0 | 2.16 | Accumulated driving time since end of last break. As soon as 4.5 hours are accumulated, the driver is no longer allowed to drive unless he/she takes a break. A value of more than 4.5 hours has the same effect as 4.5 hours. |
| accumulatedDrivingTimeSinceLastDailyRest | Duration (Double) | no | 0.0 | 2.16 | Accumulated driving time since end of last daily rest. As soon as 9 hours are accumulated, the driver is no longer allowed to drive unless he/she takes a daily rest. A value of more than 9 hours has the same effect as 9 hours. May not be smaller than accumulatedDrivingTimeSinceLastBreak, otherwise an exception is thrown. |
| elapsedTimeSinceEndOfLastDailyRest | Duration (Double) | no | 0.0 | 2.16 | Elapsed time since end of last daily rest, that is, the time between the end of the last daily rest and the reference time. As soon as 13 hours have elapsed, the driver is no longer allowed to drive or perform service unless he/she takes a daily rest. A value of more than 13 hours has the same effect as 13 hours. May not be smaller than accumulatedDrivingTimeSinceLastDailyRest, otherwise an exception is thrown. |
Defines options which can be applied to a specific driving time regulation.
| No fields defined. |
Defines options which can be applied to the US Hours Of Service regulation FMCSA 395/2013.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| thirtyFourHourRestartRule | Boolean | no | true | 2.16 | Tells if the 34-hour restart can be applied after the weekly on duty hours limit has been reached. Basically, if 34 or more consecutive hours off duty are taken, it restarts the weekly on duty hours counting to zero. |
| weeklyOnDutyHoursLimit | WeeklyOnDutyHoursLimit_US_FMCSA_395_2013 | no | WeeklyOnDutyHours ... | 2.16 | Defines the weekly on duty hours limit to apply. |
| twentyFourHourPeriodStartsAt | TimeOfDay (String) | no | 00:00 | 2.16 | Defines the start time of a 24-hour period. The weekly on duty hours limit is based on a rolling 7 or 8-day period starting at this specific time. In general, it is up to the motor carrier to set this value. |
| thirtyMinuteBreakRule | Boolean | no | true | 2.16 | Tells if the 30-minute break provision is enforced after 8 on-duty consecutive hours (e.g. it is not required to be enforced for short haul operations). |
Specifies a violation that involves a stop limit. This violation has one of the following tour event violation types: MAXIMUM_NUMBER_OF_CUSTOMER_STOPS.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| exceedance | PositiveInteger (Integer) | no | - | 2.23 | Number by which the limit is exceeded. |
Specifies a violation of the maximum quantity scenario of the used vehicle. This violation has one of the following tour event violation types: MAXIMUM_QUANTITY_SCENARIO.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| exceedance | TransportQuantityUnit[] (Double[]) | 1..10 | - | 2.5 | Exceedance of the maximum quantity scenario in each dimension. |
Specifies a violation of one or more mixed loading prohibitions, that is, two (or more) orders in a trip have conflicting categories. This violation has the following tour violation type: MIXED_LOADING_PROHIBITION.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| mixedLoadingProhibitions | MixedLoadingProhibition[] | 0..* | - | 2.25 | These are the mixed loading prohibitions that are violated by the current service event. |
Defines which rules regarding drivers' working hours need to be met in a multi day planning scenario.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| dailyRestPositions | RestPositions | no | RestPositions.BET ... | 2.5 | Indicates at which positions of a tour daily rests are planned. |
Specifies a violation for any event that is not at the expected position. This violation has one of the following tour event violation types: REST_POSITION, CUSTOMER_STOP_POSITION_IN_TRIP, TRIP_SECTION.
| No fields defined. |
Specifies a violation for missing qualification (e.g. missing equipment of the used vehicle) that is required by the tour. This violation has one of the following tour event violation types: VEHICLE_EQUIPMENT.
Specifies a violation where the route between two locations is estimated by direct distance instead of the road network, e.g. because one location is not within boundaries of map. For more information, see estimatedByDirectDistance. This violation can only occur if ignore reachability violations is not set and if distance mode is not set to direct distance. This violation has the following tour violation type: REACHABILITY.
| No fields defined. |
Specifies a violation where the route between two locations is calculated with route violations, e.g. a violation of the clearance height by the vehicle. This violation can only occur if ignore route violations is not set. This violation has the following tour violation type: ROUTE.
| No fields defined. |
Service at stop is completed.
| No fields defined. |
Service at stop has started and is currently being performed.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| performedServiceTime | Duration (double) | yes | - | 2.21 | Already performed service time at this stop. The remaining service time at this stop is the originally planned service time subtracted by the parameter performedServiceTime. No service needs to be performed at this stop any more if performedServiceTime is greater than or equal to the originally planned service time. |
Status for the service at the current stop of a tour in execution.
| No fields defined. |
Defines which rules regarding drivers' working hours need to be met in a single day planning scenario.
| No fields defined. |
Specifies a violation that involves a time limit. This violation has one of the following tour event violation types: PLANNING_HORIZON, OPERATING_INTERVAL, TOUR_START_INTERVAL, OPENING_INTERVAL, MAXIMUM_TRAVEL_TIME_PER_TOUR, MAXIMUM_DRIVING_TIME_PER_TOUR, MAXIMUM_TRAVEL_TIME_PER_DRIVER, MAXIMUM_DRIVING_TIME_PER_DRIVER, TRIP_START_INTERVAL.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| exceedance | Duration (Double) | no | - | 2.5 | Time by which the limit is exceeded. |
Base type for tour violations.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| causedByThisEvent | Boolean | no | - | 2.5 | True if the violation is caused by the tour event that contains this tour violation. For violations of type VEHICLE_EQUIPMENT and MAXIMUM_QUANTITY_SCENARIO the order ID of the tour event references the order that caused this violation. For time violations this member is true for the first event of a specific type of time violation. |
| type | TourViolationType | no | - | 2.5 | Type of the tour event violation. The documentation of the types derived from this type list the associated tour event violation types. |
The summary of a logbook of a driver (or a mobile worker) with respect to a lastTimeTheDriverWorked. If provided as input, it is taken into account when the mandatory breaks and rests are calculated.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| lastTimeTheDriverWorked | XMLGregorianCalendar | yes | - | 2.16 | The last time the driver worked (driving or performing service). It is assumed that the time since then may count as break/rest, provided it has the required minimum duration. |
| drivingTimeRegulationLogbookSummary | DrivingTimeRegulationLogbookSummary | no | - | 2.16 | The summary of a logbook corresponding to the drivingTimeRegulation. |
| workingTimeDirectiveLogbookSummary | WorkingTimeDirectiveLogbookSummary | no | - | 2.16 | The summary of a logbook corresponding to the workingTimeDirective. |
Defines which rules regarding drivers' working hours need to be complied with. See Working Hours.
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| drivingTimeRegulation | DrivingTimeRegulation | no | DrivingTimeRegula ... | 2.5 | Defines which driving time regulation is applicable. A driving time regulation concerns drivers of heavy vehicles only. |
| workingTimeDirective | WorkingTimeDirective | no | WorkingTimeDirect ... | 2.16 | Defines which legislation regarding working time is applicable. Currently only supported for SingleDayWorkingHours. Must not be used together with drivingTimeRegulation. |
| drivingTimeRegulationOptions | DrivingTimeRegulationOptions | no | - | 2.16 | Defines options for the selected driving time regulation. |
The summary of a logbook of a mobile worker. If provided as input, it is taken into account when the mandatory breaks and rests are calculated.
| No fields defined. |
According to Directive 2002/15/EC of the European Parliament and of the Council "on the organisation of the working time of persons performing mobile road transport activities".
| Field Name | Type | Required | Default | Since | Description |
|---|---|---|---|---|---|
| accumulatedWorkingTimeSinceLastBreak | Duration (Double) | no | 0.0 | 2.16 | Accumulated working time since end of last working break. The working break must have at least a duration of 30 minutes. As soon as 6 hours have elapsed, the driver is no longer allowed to work or drive unless he/she takes a break. A value of more than 6 hours has the same effect as 6 hours. |
| elapsedTimeSinceEndOfLastDailyRest | Duration (Double) | no | 0.0 | 2.16 | Elapsed time since end of last daily rest, that is, the time between the end of the last daily rest and the reference time. As soon as 9 hours have elapsed, the driver is no longer allowed to work or drive unless he/she takes a daily rest. A value of more than 9 hours has the same effect as 9 hours. May not be smaller than accumulatedWorkingTimeSinceLastBreak, otherwise an exception is thrown. |
Defines which driving time regulation needs to be complied with.
Indicates at which positions of a tour rests are planned.
Specifies the type of a tour event. In xRoute, only the following events are returned: SERVICE, WAITING, BREAK, DAILY_REST. In xTour, all the events are returned.
Specifies the type of a tour event. In xRoute, only the following types are returned: OPENING_INTERVAL, MAXIMUM_TRAVEL_TIME_PER_TOUR, MAXIMUM_DRIVING_TIME_PER_TOUR. In xTour, all the types are returned.
| Enumeration Value | Since | Description |
|---|---|---|
| PLANNING_HORIZON | 2.7 | Indicates a violation of the planning horizon. This is caused by a tour event that begins outside the planning horizon. This violation is repeated for all subsequent events of the current tour. |
| OPERATING_INTERVAL | 2.7 | Indicates a violation of the operating interval of the driver. This is caused by a tour event that begins outside of the operating intervals of the driver of the current tour. This violation is repeated for all subsequent events of the current trip. |
| TOUR_START_INTERVAL | 2.19 | Indicates a violation of the tour start interval of the vehicle. This violation is only included at tour start events. |
| OPENING_INTERVAL | 2.5 | Indicates a violation of the opening interval(s) of the current site. This is caused by service that begins after the end of the last opening interval of the current site. This violation is repeated for all subsequent events of the current stop. |
| MAXIMUM_TRAVEL_TIME_PER_TOUR | 2.5 | Indicates a violation of the maximum allowed travel time per tour. This violation is repeated for all subsequent events of the current tour. |
| MAXIMUM_DRIVING_TIME_PER_TOUR | 2.5 | Indicates a violation of the maximum allowed driving time per tour. This violation is repeated for all subsequent events of the current tour. |
| REST_POSITION | 2.5 | Indicates that a daily rest for European drivers' working hours is not at the end of a trip. The expected position for a daily rest is at the end of a trip. Daily rests at other positions are only scheduled if they are absolutely necessary to conform to the European drivers' working hours. This violation is only included at tour events of the violated daily rest. |
| MAXIMUM_QUANTITY_SCENARIO | 2.5 | Indicates a violation of the maximum quantity scenario of the used vehicle. This violation is repeated for all subsequent events for which the maximum quantity of the vehicle is exceeded. |
| VEHICLE_EQUIPMENT | 2.5 | Indicates a violation of the vehicle equipment required for the currently loaded orders. This violation is repeated for all subsequent events for which a vehicle equipment is missing. |
| MAXIMUM_TRAVEL_TIME_PER_DRIVER | 2.14 | Indicates a violation of the maximum allowed travel time per driver as specified by the drivers' working hours restriction. Travel time prior to tour start as specified by the work logbook summary is also considered for this check. This violation is repeated for all subsequent events of the current tour. |
| MAXIMUM_DRIVING_TIME_PER_DRIVER | 2.14 | Indicates a violation of the maximum allowed driving time per driver as specified by the drivers' working hours restriction. Driving time prior to tour start as specified by the work logbook summary is also considered for this check. This violation is repeated for all subsequent events of the current tour. |
| TRIP_START_INTERVAL | 2.19 | Indicates a violation of the trip start interval. This violation is only included at trip start events. |
| MAXIMUM_NUMBER_OF_CUSTOMER_STOPS | 2.23 | Indicates a violation of the maximum allowed number of stops per tour. This violation only occurs at events of type service at customer stops and is repeated for all subsequent events. |
| CUSTOMER_STOP_POSITION_IN_TRIP | 2.23 | Indicates a violation of the customer stop position in trip. This violation only occurs at events of type service at customer stops when a position in trip set for this site and the current customer stop is not the first/last one in the trip. |
| TRIP_SECTION | 2.23 | Indicates a violation of the trip section numbers. This violation only occurs at events of type service at customer stops when the previous trip section number is higher than the one at this customer site. |
| MAXIMUM_DISTANCE | 2.24 | Indicates a violation of the maximum allowed distance per tour. This violation is repeated for all subsequent events of the current tour. |
| MIXED_LOADING_PROHIBITION | 2.25 | Indicates a violation of a mixed loading prohibition. This violation only occurs at events of type service. |
| ROUTE | 2.25 | Indicates a violation where the route between two locations is calculated with route violations. This violation only occurs at events of type driving. |
| REACHABILITY | 2.25 | Indicates a violation where the route between two locations was calculated by direct distance instead of the road network. This violation only occurs at events of type driving. |
| UNSPECIFIED | 2.5 | Fallback value to be substituted for enumeration values which were added in an API version that is newer than the request version. When using the current API, this value will never be returned. |
Defines the possible weekly on duty limit for the US Hours Of Service regulation FMCSA 395/2013.
Defines which legislation regarding working time is applicable.