This VRP request schema is used for solving a Vehicle Routing Problem. It consists of resources, jobs, options
and weights.

Name	Type	Required	Description
`resources`	[Resource]	true	List of Resources
`jobs`	[Job]	true	List of Jobs
`options`	Options	false	Options for solver configuration
`weights`	Weights	false	Weighting the constraints
`hook`	string(uri)	false	Webhook for getting notified after request is solved.

Job

A job to be performed by a resource.

Name	Type	Required	Description
`name`	string	true	Unique description
`duration`	integer	false	Service duration of the job
`location`	Location	false	Job location
`priority`	integer	false	Priority of the job will ensure that it is included in the planning over other lower priority jobs.
`tags`	[Tag]	false	A tag is a string that can be used to link jobs to resources.
`windows`	[TimeWindow]	false	List of start/end date/time combinations.
`durationSquash`	integer	false	When a job is performed at the same location as another job, `durationSquash` ensures that the 2nd job' service time is reduced to this value. Example: `duration=600` and `durationSquash=30` means that the 2nd job will only take 30 seconds to perform.
`plannedDate`	date	false	Fixed date on which this job is already planned and should hence be taken into account in the planning.
`plannedResource`	string	false	Name of the resource to which this job is already planned and should hence be taken into account in the next planning.
`plannedArrival`	date-time	false	Planned arrival time The second of day at which the job is planned to complete. The difference with the actual arrival time is scaled in the score with plannedWeight.
`hard`	boolean	false	In the case of partial planning, this indicates whether this job should be integrated into the planning or not.
`hardWeight`	integer	false	In the case of partial planning, this indicates the weight of this job.
`padding`	integer	false	Padding time (in seconds) before and after the job.
`allowedResources`	[string]	false	Resources that are allowed to be assigned to this job.
`load`	[int]	false	The load of the job expressed as list of integer values

TimeWindow

A time window is a time period in which a job can be performed.

Name	Type	Required	Description
`from`	date-time	true	Date time start of window
`to`	date-time	true	Date time end of window
`weight`	integer	false	Weight constraint modifier
`hard`	boolean	false	Hard constraint violation of DateWindow

Tag

Name	Type	Required	Description
`name`	string	true	Tag restriction name which can force some Jobs to be scheduled by Resources with the same tag
`hard`	boolean	false	Hard or soft constraint.
`weight`	integer	false	Value of the weight. This will be on the same level as travel time in the case of soft constraint.

Location

Name	Type	Required	Description
`latitude`	number	true	Latitude (WGS84)
`longitude`	number	true	Longitude (WGS84)

Resource

A resource is a vehicle or person that can perform jobs.

Name	Type	Required	Restrictions	Description
name	string	true	none	Unique name
start	Location	false	none	Start location
end	Location	false	none	End location
shifts	[Shift]	true	none	Shift definition of a Resource over course of planning period
maxDriveTimeInSeconds	integer	false	none	Maximum drive time in seconds
tags	[string]	false	none	Tag requirements
maxDriveTime	integer	false	none	none
maxDriveTimeJob	integer	false	none	none
category	Category	false	none	none
region	Location	false	none	Geographical Location in WGS-84
rules	[Rule]	false	none	none
capacity	[int]	false	none	Represents the capacity of the resource as a list of integers

{
  "name": "R-1",
  "start": {
    "latitude": 50.0987624,
    "longitude": 4.23849204
  },
  "end": {
    "latitude": 50.0987624,
    "longitude": 4.23849204
  },
  "shifts": [
    {
      "from": "2022-03-10T12:15:50",
      "to": "2022-03-10T12:15:50",
      "start": {
        "latitude": 50.0987624,
        "longitude": 4.23849204
      },
      "ignoreTravelTimeToFirstJob": true,
      "ignoreTravelTimeFromLastJob": true,
      "breaks": [
        {
          "duration": 1800,
          "start": "2022-03-10T12:15:50",
          "end": "2022-03-10T12:15:50"
        }
      ]
    }
  ],
  "tags": [
    "Technician"
  ],
  "rules": [
    {
      "period": {
        "start": "2007-12-01",
        "end": "2007-12-31"
      },
      "minWorkTime": 0,
      "maxWorkTime": 0,
      "minServiceTime": 0,
      "maxServiceTime": 0,
      "minDriveTime": 0,
      "maxDriveTime": 0
    }
  ]
}

Shift

Name	Type	Required	Description
`from`	date-time	true	Start of the shift datetime
`to`	date-time	true	End of the shift datetime
`start`	Location	false	Start location
`end`	Location	false	End of the shift datetime
`ignoreTravelTimeToFirstJob`	boolean	false	Ignore the travel time from the start location to the first job
`ignoreTravelTimeFromLastJob`	boolean	false	Ignore the travel time from the last job to the optional end location
`overtimeEnd`	date-time	false	Maximum overtime time.
`breaks`	[WindowBreak]	false	Maximum overtime time.

Rule

{
  "period": {
    "start": "2007-12-01",
    "end": "2007-12-31"
  },
  "minWorkTime": 0,
  "maxWorkTime": 0,
  "minServiceTime": 0,
  "maxServiceTime": 0,
  "minDriveTime": 0,
  "maxDriveTime": 0
}

Name	Type	Description
`period`	Period	Subset of the planning period
`minWorkTime`	integer	Minimum total work time in seconds
`maxWorkTime`	integer	Maximum total work time in seconds
`minServiceTime`	integer	Minimum service time in seconds
`maxServiceTime`	integer	Maximum service time in seconds
`minDriveTime`	integer	Minimum drive time in seconds
`maxDriveTime`	integer	Maximum drive work time in seconds

Period

Name	Type	Required	Description
`from`	date-time	true	none
`to`	date-time	true	none

Example:

{
  "from": "2007-12-01",
  "to": "2007-12-31"
}

WindowBreak

Name	Type	Required	Description
`duration`	integer	true	Break duration in seconds
`from`	date-time	true	Earliest start for a break
`to`	date-time	true	Latest start for a break

{
  "duration": 1800,
  "from": "2022-03-10T12:00:00",
  "to": "2022-03-10T12:45:00"
}

This means a 30 minute break somewhere between 12:00 and 12:45 on 10 March 2022.

Weights

Weights are modifiers for the objective function. They are used to influence the score calculation on the soft level.
Everything is compared with Travel Time (in seconds).

Name	Type	Description
`priorityWeight`	integer	Weight modifier for `job.priority` that ensures that priority jobs are scheduled. Note that this does not make sure that they are scheduled sooner.
`workloadSpreadWeight`	integer	Weight modifier for service time per vehicle day.
`travelTimeWeight`	integer	Weight modifier for travel time.
`plannedWeight`	integer	Weight modifier for planned vehicle and planned date requirement.
`asapWeight`	integer	Weight modifier scheduling jobs as soon (on day basis) as possible.
`minimizeResourcesWeight`	integer	Weight modifier when selecting a resource to have at least 1 job assigned. When `minimizeResourcesWeight` is set to `1800` then it means that only having a detour of half an hour would start to trigger having an extra resource.

{
  "priorityWeight": 1,
  "workloadSpreadWeight": 1,
  "travelTimeWeight": 1,
  "plannedWeight": 1,
  "asapWeight": 1,
  "minimizeResourcesWeight": 1
}

Options

Name	Type	Description
`partialPlanning`	boolean¦null	If you do not need to assign every job to a vehicle, then set `partialPlanning: true`.
`minimizeResources`	boolean¦null	Minimise the vehicle useage or minimise total travel time. Two different objective functions. Can be extra enforced with `minimizeResourcesWeight`.
`traffic`	number(double)¦null	Modifier to travel time for traffic. If you want actual traffic information, use HERE or TomTom map integration.
`polylines`	boolean¦null	Let our map server calculate the actual polylines for connecting the visits. Processing will take longer.
`fairWorkloadPerTrip`	boolean¦null	If true, the workload (service time) will be spread over all vehicles and all days. (interacts with `Weights.workloadSpreadWeight` and `options.workloadSensitivity`)
`fairWorkloadPerResource`	boolean¦null	If true, the workload (service time) will be spread over all days of one vehicle. (interacts with `Weights.workloadSpreadWeight` and `options.workloadSensitivity`)
`snapUnit`	integer(int32)¦null	The smallest steps in arrival time to which results will be snapped. The snapping policy is round-up and is used at runtime, implying it influences the score calculation. Unless a post-calculation feature such as job padding is used, any calculated arrival time in `[391, 395]` with a `snapUnit` of `5` will yield `395`. Fallback value for `Options.use_snapUnit_for_waitRange`.
`workloadSensitivity`	number¦null	Sensitivity factor on fairness