Introduction

Welcome to the adiutaByte API. The goal of the API is to provide an interface for generating plans for various fleet optimization problems. This API description is intended to help setting up your own code to access the adiutaByte API. Currently there are two API endpoints implemented. The first one is for submitting a problem description, for which an optimized plan is then calculated. The second endpoint is for retrieving this finalized plan.

The API uses token-based authentication to protect these endpoints; users are generated on demand. Feel free to contact us for such a personalized access.

The furthest right column of this page will provide examples to data structures, requests or responses. Additionally there will be a few code snippets for some languages. With the tabs in the upper right corner you can switch the example's programming language.

Currently the API solely supports JSON formatted data. For the JSON structures there is a schema that is used to validate the data. Non-valid requests are immediately rejected with an error message. The structure and meaning of the JSON data used is shown in the first part of the following description. In each section a downloadable corresponding JSON schema in the latest version is linked.

For the different requests you need to insert some entries in the header:

• Authorization (your ID-token, see Authentication)
• Accepts ("application/json")
• Content-Type ("application/json")

Currently we distinguish between users whose limits for how many tasks can be planned within a month are managed by us, and accounts which are used for clients, to which a special management account exists to register new clients. For such an account the limits are set per client. The account for submitting plans and the account for management use the same e-mail-address but need to identify against different cognitio pools. The configuration for the different account types can be found in Authentication. To identify the different clients you need to relay the client-ID to the backend in every request.

Tags

• Features that are planned and not yet implemented are marked with TBA (Example: timeEarliest ^TBA). These are in a conceptual phase and might still get changed or deleted.
• Some features might not yet work, depending on what application version the plan is being calculated on. Features that are not yet live for all requests are marked with the version they are first introduced on (Example: timeEarliest ^v1.0.0). To determine the used version, check the field backendVersion in the response or contact us.

Examples in this documentation will use all listed fields regardless of their introduced version, so please check availability before using them.

Restrictions

Certain values on input objects can restrict the general set of available solutions. These include time windows on tasks, workers or shifts, preferences of all kinds, categories, qualifications and many more. Due to the nature of optimization, not all of them can be kept nor is that even intended, as violating a constraint can often lead to vast improvements regarding another metric. Nevertheless there are some constraints the algorithm will keep at all costs, as they are deemed too important to be disregarded.

To differentiate the types of constraints, there will be an occasional Depends on column added to the parameter listing. It can contain a number of different text markers:

• "strict": A constraint that the algorithm either literally cannot violate or can do so but only in a worst-case scenario, for instance to keep another strict constraint. (Example: Qualifications)
• An optimization parameter: The constraint depends on the optimization parameter setting. The higher the setting value, the more likely it is for the restriction to be kept. However, unless noted otherwise, it cannot reach the importance level of a strict constraint. (Example: preferredWorkers)
• Nothing: The parameter either is not a constraint or its importance cannot be influenced via input data settings. (Example: gender or desiredWorker)

Contact us

If you notice issues or an error with the documentation, if you have questions regarding the API or its documentation or if you're having another related issue, please contact us.

Deprecation Warnings

The following features are deprecated and will be removed in a future version. Requests using these features will still get accepted in plan requests but do not influence calculations in any way.

v2.0.0

• In Unassigned MixedPlannerTask: description
• In Assigned MixedPlannerTask: description
• In Unassigned MixedPlannerWorker: hoursPerWeek
• In Assigned MixedPlannerWorker: hoursPerWeek

v3.0.0

• In Common Types: Obstacle
• In Mixedplanner-Metainformation: integrateDurationExtensions- always set to true
• In Mixedplanner-Optimization-Parameters: workTimeRelax
• In Mixedplanner-Optimization-Parameters: travelTimeRelax
• In MixedPlanner-Request: obstacles
• In MixedPlanner-Results: obstacles - If the array is included in the request, it will still be sent back in the response.

Definition of common types

Integers/Numbers

Examples:

{
  "integer_u32": 12,
  "integer_s32": -12,
  "number_u32" : 7.184535,
  "number_s32" : -7.184535,
  "number_u64" : 7.184535,
  "number_s64" : -7.184535,
  "fraction"   : 0.2
}

JSON-Schema

The following ranges get used for values of type integer/ number:

Please refer to the respective linked json schema to determine which type of integer/number gets used.

GeoCoord

Examples:

{
  "lat": 50.780241,
  "lng": 7.184535
}

JSON-Schema

Date

Examples:

"2018-01-10"
"2019-12-03"
"2020-05-23"

JSON-Schema

A string consisting of three parts following the pattern "YYYY-MM-DD":

• "YYYY": year AD, $ 2010 \leq x \leq 2099 $
• "MM": month, $ 1 \leq x \leq 12 $
• "DD": day, $ 1 \leq x \leq 31 $

Time

Examples:

"06:59"
"15:59"
"1230:33"
"-39:12"
"03:01"

JSON-Schema

A string of either format "hh:mm" or "-hh:mm":

• "hh": hours, $ 0 \leq x \leq 9999 $
• "mm": minutes, $ 0 \leq x \leq 59 $ with exactly 2 digits

All times are interpreted in 24-hour notation and relative to midnight ("00:00") of a certain defined date. Those dates are:

• shiftDate for any Time values in Shift
• date for any Time values in Unassigned MixedPlanner-Task and Assigned MixedPlanner-Task
• shiftDate for any Time values in Unassigned MixedPlanner-Worker and Assigned MixedPlanner-Worker
• date for any Time values in Unassigned ShiftPlanner-Task and Assigned ShiftPlanner-Task.

This means that the following times applied to the respective date (in Date format) are equivalent:

• "2021-05-21" at "07:25"
• "2021-05-20" at "31:25"
• "2021-05-19" at "55:25"
• "2021-05-22" at "-16:35"
• "2021-05-23" at "-40:35"

Input data containing only identical dates and no time of format "-hh:mm" will not result in output data containing times of format "-hh:mm".

VehicleType

JSON-Schema

An integer in the range $0 \leq x \leq 4$.

GenderType

JSON-Schema

An integer in the range $0 \leq x \leq 3$.

LanguageType

JSON-Schema

An integer in the range $0 \leq x \leq 1$.

Parameter Preset

An integer in the range $0 \leq x \leq 4$. Depending on the type of plan (MixedPlanner/ ShiftPlanner) not all presets are valid for use. For more information please refer to the respective preset specification.

Location Site

Examples:

{
  "locationSiteID": 200,
  "location": {
    "lat": 50.878847,
    "lng": 6.964728400000013
  }
}

JSON-Schema

A location site is a GeoCoord which can be referenced by an id in various places:

• startLocationSiteID
• endLocationSiteID
• capacityResetLocationSiteIDs
• locationSiteID

Shift

Examples:

{
  "shiftID": 1,
  "shiftDate": "2019-12-03",
  "shiftStart": "05:00",
  "shiftEnd": "12:00"
}

{
  "shiftID": 1,
  "shiftDate": "2019-12-03",
  "shiftStart": "05:00",
  "shiftEnd": "12:00",
  "shiftPriority": 2
}

JSON-Schema

A shift represents a worker's timeslot in which exactly one ShiftPlanner-Task can be carried out. For exceptions see the groupOrder parameter in ShiftPlanner-Tasks.

Construction Site

Examples:

{
  "constructionSiteID": 666,
  "startDate": "2020-07-23",
  "endDate": "2020-07-25",
  "startPoint": {
    "lat": 48.17083,
    "lng": 11.3292
  },
  "endPoint": {
    "lat": 48.16774,
    "lng": 11.33253
  },
  "info": "Waldstraße gesperrt 2020"
}

JSON-Schema

A construction site gets represented by a straight line between its startPoint and endPoint. These can be identical for small scale obstructions.

Clientinformation

Examples:

{
  "clientID": "{1234-5678-9123}"
}

JSON-Schema

Obstacle

DEPRECATED

Backend Version

Introduced in: v2.35.0

Examples:

{
  "schema": "v0.0.0"
}

{
  "schema": "v0.0.0",
  "version": "v0.0.0",
  "rev": "abde12"
}

JSON-Schema

Definition of MixedPlanner-Types

Mixedplanner-Metainformation

Examples:

{
  "dateFrom": "2019-12-03",
  "dateTo": "2019-12-03"
}

{
  "dateFrom": "2019-12-03",
  "dateTo": "2019-12-03",
  "resCapacity": true,
  "resCategory": true,
  "resQualification": true,
  "postProcessing": true,
  "accuracyMode": 1.0,
  "outputLanguage": 1,
  "tightSchedule": true,
  "travelTimeMin": 5,
  "integrateGermanBreakRegulations": true,
  "enablePlanSplitting": false,
  "allowUnassignedTasks": true,
  "useInitialClustering": true,
  "dontOptimizeResets": true,
  "minConcurrentSolutions": 1
}

JSON-Schema

Notes

• The options res* describe which fields from the dataset should be taken into account. More precisely those are:
  • resCapacity: capacity (Task), volume (Task), weight (Task), capacity (Worker), capacityInitial, capacityResetDuration, capacityResetLocationSiteIDs, [finalCapacityResetThreshold], volume (Worker), volumeInitial, finalVolumeResetThreshold, weight (Worker), weightInitial, finalWeightResetThreshold
  • resCategories: categories (Task), antiCategories, exchangeableCategories, twinCategories, categories (Worker), prefCategories, desiredCategory
  • resQualification: qualification (Task), qualification (Worker)

• Using the option allowUnassignedTasks enables an unassignment behavior in the algorithm, meaning it will, if deemed necessary, refuse to assign subsets of tasks to any worker. Examples are scenarios where the only qualified workers are overloaded or there are no workers that can even carry out a task. In the output data this can be recognized by the task missing its assignment data, such as timeScheduled or travelTime. The differences to an assigned task are noted in the description for the Assigned MixedPlanner-Task. Additionally, the info section will notify of unassignment and, if possible, the reason for it.

• Per default, travel from and to capacity reset locations is part of the optimization, after a reset the worker will often continue their tour closer to the reset location. Other tours might lead to or from reset locations to minimize travel from the task before reset to the reset location and vice versa from the reset location to the next task. While this behavior is no doubt beneficial for reducing travel time/ distance, it can lead to unwanted results in use cases where a high amount of clustering is intended, since from a pure time/distance approach, it makes little sense to have a worker return to their cluster after a reset. For these cases, the option dontOptimizeResets can be set to true so that travel to and from reset locations does not get considered in the optimization anymore. Of course, the travel will still get factored into scheduled times etc, but the algorithm will no longer consider these travels as part of the optimization.

Mixedplanner-Optimization-Parameters

Examples:

{}

{
  "preset": 1
}

{
  "preset": 1,
  "fairDistribution": 4,
  "localityClustering": 2,
  "shortPaths": 7,
  "timeliness": 5,
  "workerPrefs": 5,
  "workerReduction": 1,
  "genderPref": 2,
  "profitability": 3
}

JSON-Schema

All parameters are integer numbers $ 0 \leq x \leq 9 $. You only need to pass the ones you want to use, all others will be implicitly set to 0.

The following presets are currently available (parameters not listed are set to 0):

Unassigned MixedPlanner-Task

Examples:

{
  "taskID": 200,
  "date": "2019-12-03",
  "duration": 65,
  "timeEarliest": "10:00",
  "timeLatest": "12:00"
}

{
  "taskID": 200,
  "externalID": "id123",
  "clientID": 1,
  "baseScheduleTime": "10:00",
  "date": "2019-12-03",
  "duration": 65,
  "timeEarliest": "10:00",
  "timeLatest": "12:00",
  "forbTimeEarliest": "10:00",
  "forbTimeLatest": "12:00",
  "timePriority": 2,
  "location": {
    "lat": 50.878847,
    "lng": 6.964728400000013
  },
  "locationSiteID": 1,
  "prefWorkers": [1,2],
  "antiWorkers": [3,4],
  "forbWorkers": [3,4],
  "capacity": 40,
  "weight": 40,
  "volume": 40,
  "qualification": 3,
  "categories": [1],
  "antiCategories": [2],
  "exchangeableCategories": [4,5,6],
  "twinCategories": [3],
  "preassignedWorker": 2,
  "desiredWorker": 1,
  "initassignedWorker": 1,
  "initassignedOrder": 1,
  "initassignedShiftID": 1,
  "prefGender": 1,
  "precedingTasks": [1, 2],
  "predecessorTasks": [3],
  "revenue": 1.25,
  "travelTimeExtra": 2,
  "group": 2,
  "assignmentPriority": 2
}

JSON-Schema.

The unassigned task is the incoming task description for the optimizer outlining the restrictions for the optimization.

Restrictions

• forbTimeEarliest requires forbTimeLatest
• forbTimeLatest requires forbTimeEarliest
• Only one of location and locationSiteID is allowed
• Only one of initassignedWorker, preassignedWorker and desiredWorker is allowed
• initassignedOrder requires initassignedWorker or preassignedWorker
• initassignedShiftID requires initassignedWorker or preassignedWorker

Notes

• Positive numbers for capacity, volume or weight represent loading tasks while negative numbers for capacity, volume or weight represent unloading tasks.

Assigned MixedPlanner-Task

Examples:

{
  ... // see Unassigned MixedPlanner-Task
  "info": "text"
}

{
  ... // see Unassigned MixedPlanner-Task
  "timeScheduled": "12:10",
  "travelTime": 3,
  "travelDistance": 1.1,
  "assignedWorker": 1,
  "info": "text",
  "profit": -1.2,
  "finalassignedOrder": 4
}

{
  ... // see Unassigned MixedPlanner-Task
  "timeScheduled": "12:10",
  "travelTime": 3,
  "travelDistance": 1.1,
  "assignedWorker": 1,
  "assignedShiftID": 2,
  "info": "text",
  "profit": -1.2,
  "performResetBeforeAtID": 3,
  "finalassignedOrder": 4
},

The json schema for the Assigned MixedPlanner-Task extends the schema of the Unassigned MixedPlanner-Task by all the fields marked "Extension" in the table below:

• JSON-Schema (unassigned)
• JSON-Schema (assigned)

The assigned task - after the performed optimization - extends the unassigned task with information about when the task is scheduled and by whom it will be completed. Additionally some predictive metrics about the distance and travel time to reach this task are added.

Notes

• The value travelTime also includes travel times to and from a capacity reset location, as well as the reset duration, if a reset is performed directly before this task. The following table provides the calculations in each case:

• In case no actual travel happens (for instance identical locations of consecutive tasks, no location or no startLocation/ endLocation ) the values $max( actualTravelTime, travelTimeMin )$ and similar are zero.

Unassigned MixedPlanner-Worker

Examples:

{
  "workerID": 1,
  "shiftStart": "06:00",
  "shiftEnd": "14:00",
  "shiftDate": "2019-12-03"
}

{
  "workerID": 1,
  "shiftID": 10,
  "externalID": "id123",
  "startLocation":{
    "lat": 50.878847,
    "lng": 6.964728400000013
  },
  "startLocationSiteID": 4,
  "endLocation":{
    "lat": 50.878847,
    "lng": 6.964728400000013
  },
  "endLocationSiteID": 5,
  "shiftDate": "2019-12-03",
  "shiftStart": "06:00",
  "shiftEnd": "14:00",
  "shiftPriority": 2,
  "capacity": 20.5,
  "capacityInitial": 10.1,
  "capacityResetLocationSiteIDs": [1,2],
  "capacityResetDuration": 10,
  "maxResets": 2,
  "volume": 12.5,
  "volumeInitial": 5.5,
  "weight": 2.5,
  "weightInitial": 1.0,
  "finalCapacityResetThreshold": 12.1,
  "finalVolumeResetThreshold": 5.5,
  "finalWeightResetThreshold": 1.5,
  "qualification": 1,
  "categories": [4,5],
  "desiredCategory": 1,
  "prefCategories": [6],
  "breakStartEarliest": "12:21",
  "breakEndLatest": "13:00",
  "breakDuration": 10,
  "breakLocationSiteID": 1,
  "vehicleType": 1,
  "gender": 1,
  "costsPerKM": 0.05,
  "costsPerMinute": 1.23,
  "costsInitial": 234.56,
  "maxDesiredTotalDistance": 100.0,
  "maxDesiredSingleDistance": 5.0,
  "dontAlter": true,
  "dontVary": true
}

JSON-Schema

The worker has both optional and required parameters as marked in the following table.

Restrictions

• Only one of startLocation and startLocationSiteID are allowed
• Only one of endLocation and endLocationSiteID are allowed
• capacityInitial requires capacity
• capacityResetLocationSiteIDs requires capacity, weight or volume
• capacityResetDuration requires capacityResetLocationSiteIDs
• maxResets requires capacityResetLocationSiteIDs
• volumeInitial requires volume
• weightInitial requires weight
• finalCapacityResetThreshold requires capacity and capacityResetLocationSiteIDs
• finalVolumeResetThreshold requires weight and capacityResetLocationSiteIDs
• finalWeightResetThreshold requires volume and capacityResetLocationSiteIDs
• breakStartEarliest requires breakEndLatest, breakDuration
• breakEndLatest requires breakStartEarliest, breakDuration
• breakDuration requires breakStartEarliest, breakEndLatest
• breakLocationSiteID requires breakStartEarliest, breakEndLatest, breakDuration
• Only one of dontVary and dontAlter is allowed to be true

Notes

• When no startLocation or startLocationSiteID is given, the shift of the worker will start at the first assigned task with no travel time or distance to it. This can be used in situations where workers start their day at home and any travel time to their first client does not count as working time. (By analogy: endLocation/endLocationSiteID)

• Categories specified in desiredCategory and prefCategories are automatically considered valid as if they're listed in categories.

• A worker with dontVary set to true is "fixed" for the optimizer, meaning they get assigned all tasks (and only those tasks) that have this worker set as preassignedWorker or initassignedWorker in the order of initassignedOrder. That also means that initassignedOrder is required for these tasks, as well as shiftID on the worker and initassignedShiftID on the task if the workerID is not unique. Travel times, resets, etc still get calculated on both worker and task and the worker and its tasks will be considered in MixedPlanner-Statistics and MixedPlanner-Info.

• Workers with dontAlter set to true behave similarly to workers with dontVary. The only difference is that a dontVary-worker cannot get assigned more tasks than specified in the input data, a dontAlter-worker will be assigned all tasks that have this worker as initassignedWorker or preassignedWorker, but can also have other tasks assigned. While the preassigned/initassigned tasks will be in order of initassignedOrder, other tasks can be inserted before, between or after those tasks; if there is no initassignedOrder set, the task will be ignored. Every other behavior and requirement is exactly as in dontVary.

Assigned MixedPlanner-Worker

Examples:

{
  ... // See Unassigned MixedPlanner-Worker
  "travelHomeTime": 2,
  "travelHomeDistance": 1.123,
}

{
  ... // See Unassigned MixedPlanner-Worker
  "travelHomeTime": 2,
  "travelHomeDistance": 1.123,
  "breakStartEarliest": "10:00",
  "breakEndLatest": "11:00",
  "breakDuration": 30,
  "breakScheduled": "12:10"
}

{
  ... // See Unassigned MixedPlanner-Worker
  "travelHomeTime": 2,
  "travelHomeDistance": 1.123,
  "info": "text",
  "breakScheduled": "12:10"
}

The json schema for the Assigned MixedPlanner-Worker extends the schema of the Unassigned MixedPlanner-Worker by all the fields marked "Extension" in the table below: JSON-Schema.

The assigned worker - after the performed optimization - extends the unassigned worker with data regarding assignment, breaks or other textual information.

Notes

• If an Unassigned MixedPlanner-Worker does not already contain the data breakStartEarliest, breakEndLatest or breakDuration, integrateGermanBreakRegulations is set to true and the worker has to take a break due to their shift length and German law, the automatically generated break data regarding these values will be added to the Assigned MixedPlanner-Worker as extension. If these values were already written in the Unassigned MixedPlanner-Worker, they do not get changed in the Assigned MixedPlanner-Worker. If the values were not written in the Unassigned MixedPlanner-Worker but integrateGermanBreakRegulations is set to false or German law does not require a break for this shift, no data will be added.

MixedPlanner-History

Examples:

{
  "tasks": [
    {
      "taskID": 0,
      "clientID": 100,
      "scheduling": [
        {
          "date": "2000-01-01"
        }
      ]
    }
  ],
  "workers": [
    {
      "workerID": 0
    }
  ]
}

JSON-Schema

MixedPlanner-History-Assignment

Examples:

{
  "date": "2000-01-01"
}

{
  "date": "2000-01-01",
  "baseScheduleTime": "00:00",
  "baseWorker": 1,
  "timeScheduled": "00:00",
  "assignedWorker": 0,
  "timeVariance": 0,
  "timePriority": 0,
  "timeScheduledAutomatically": "00:00",
  "assignedWorkerAutomatically": 0,
  "actualStartTime": "00:00",
  "actualWorker": 0,
  "prevTask": 0
}

JSON-Schema

MixedPlanner-History-Task

Examples:

{
  "taskID": 0,
  "clientID": 100,
  "scheduling": [
    {
      "date": "2000-01-01"
    }
  ]
}

JSON-Schema

MixedPlanner-History-Worker

Examples:

{
  "workerID": 0
}

{
  "workerID": 0,
  "gender": 1,
  "qualification": 1,
  "categories": [ 1,2 ]
}

JSON-Schema

MixedPlanner-Statistics

Examples:

{
  "configuration": [
    {
      "label": "Short Path",
      "value": 0.777778
    }
  ],
  "workload": [
    {
      "workerID": 1,
      "values": [
        0,0,0,0,0,0,0.97,1,0.5,0.17,0.07,0.5,0,0,0,0,0,0,0,0,0,0,0
      ]
    }
  ],
  "travelTimes": [
    {
      "workerID": 1,
      "time": 51
    }
  ],
  "travelDistances": [
    {
      "workerID": 1,
      "distance": 32.1
    }
  ],
  "taskTimes": [
    {
      "workerID": 1,
      "time": 145
    }
  ],
  "taskBusyness": [
    {
      "workerID": 1, 
      "busyness": 0.3
    }
  ],
  "travelBusyness": [
    {
      "workerID": 1,
      "busyness": 0.4
    }
  ],
  "workTimeDistribution": [
    {
      "type": "Working Time",
      "time": 716
    }
  ],
  "preferredWorkers": [
    {
      "type": "matched",
      "count": 12
    },
    {
      "type": "unmatched",
      "count": 7
    }
  ],
  "preferredGender": [
    {
      "type": "matched",
      "count": 3
    },
    {
      "type": "unmatched",
      "count": 4
    }
  ],
  "desiredWorkers": [
    {
      "type": "matched",
      "count": 9
    },
    {
      "type": "unmatched",
      "count": 13
    }
  ],
  "vehicleTypeDistances": [
    {
      "vehicleType": 0,
      "distance": 9.123
    },
    {
      "vehicleType": 3,
      "distance": 4.2
    }
  ],
  "impact": [
    {
      "label": "Anticategories",
      "value": 0.123
    }
  ],
  "unassignedTaskIDs": [1,2,3],
  "unassignableTaskIDs": [1,2,3],
  "timeWindowViolationTaskIDs": [1,2,3],
  "routeLength": 146.841095,
  "onTime": 96,
  "planProfitability": 150.12
}

JSON-Schema

Notes

• The array configuration contains the following fields. They are translated based on the language setting and are all required:

• The array workTimeDistribution contains the following fields. They are translated based on the language setting and are all required:

• The array impact contains all restriction types and gives a percentage (0.0-1.0) evaluation of each restriction's final influence on the algorithmic optimization and plan result. This can be used to detect logical problems in the input data, i.e. too restrictive time windows, large travel times or a large amount of worker preferences that just cannot be fulfilled. However, please note that if a restriction is listed in impact with a value greater zero, it does not mean that there even is a way to erase its impact. For instance, travel values will always be featured unless the total amount of travel time is zero or the shortPaths option is set to zero.

MixedPlanner-Info

Examples:

{
  "text": "Alle Aufgaben wurden valide den Mitarbeitern zugewiesen!",
  "balance": "4 Mitarbeiter sind eingeplant\n6,2 Aufgaben durchschnittlich (pro Mitarbeiter)\n1,2 Aufgaben Abweichung von der durchschnittlichen Aufgabenzahl (pro Mitarbeiter)\nAufgaben- und Reisezeiten in Summe: 886 Minuten\nSchichtzeiten in Summe: 1860 Minuten\nAuslastung (netto): 47,6%",
  "dist": "146,8 km auf der Straße",
  "pref": "12 Aufträge werden von einem gewünschten Mitarbeiter durchgeführt, bei 7 Aufträgen war dies leider nicht sinnvoll oder möglich",
  "relax": "Aufträge:\n\nPrognostizierte kurze Verspätungen [5-30 Minuten] (4%):\n200, \n\nPrognostizierte Verspätungen [über 30 Minuten] (0%):\n\n\nDie anderen 24 Aufgaben (96%) werden pünktlich erreicht!\n\nSchichten:\nAlle Mitarbeiterschichten können eingehalten werden.",
  "time": "170 Minuten auf der Straße\n42,5 Minuten auf der Straße durchschnittlich (pro Mitarbeiter)\n9,0 Minuten Reisezeitvarianz (pro Mitarbeiter)",
  "feasible": false,
  "constructionSites": [
    {
      "constructionSiteID": 666,
      "startDate": "2020-07-23",
      "endDate": "2020-07-25",
      "startPoint": {
        "lat": 48.17083,
        "lng": 11.3292
      },
      "endPoint": {
        "lat": 48.16774,
        "lng": 11.33253
      },
      "info": "Waldstraße gesperrt 2020"
    }
  ]
}

JSON-Schema

Notes

• All text in text, balance, dist, pref, relax, time gets translated based on language setting.

Travel Override

Introduced in: v2.31.0

{
  "sparse": [
    {
      "vehicleTypes": [0,2],
      "sourceIDs": [12,13,1,12],
      "targetIDs": [14,11,12,1],
      "travelTime": [3.1,0.4,1.0,1],
      "travelDistance": [2.83,1.5,2.01,3.12]
    },
    {
      "vehicleTypes": [1],
      "sourceIDs": [12,13,1,12],
      "targetIDs": [14,11,12,1],
      "travelTime": [0.3,4.1,1.0,1],
      "travelDistance": [2.83,1.5,2.01,3.12]
    }
  ],
  "dense": [
    {
      "travelTime": [0,0.2,3.1,4,0,2.1,12.01,5,0],
      "travelDistance": [0,1.123,2.123,3.456,0,4.5,2.123,10.11,4.9,0],
      "vehicleTypes": [0,3]
    },
    {
      "travelTime": [0,2.1,3.0,4,0,2.01,0.12,5,0],
      "travelDistance": [0,1.123,2.123,3.456,0,4.5,2.123,10.11,4.9,0],
      "vehicleTypes": [2]
    }
  ]
}

JSON-Schema

The base schema consists of a single dense and/or a single sparse array, but at least one element:

A single entry in the dense array looks like this: JSON-Schema

Example: The travelTime array [0,2,3,4,0,2,12,5,0] translates to the following 3x3 matrix:

A single entry in the sparse array looks like this: JSON-Schema

Notes

• In the text above, LocationSiteID refers to locationSiteID.
• Entries in travelTime and travelDistance are considered "not set" if they are either 0 or -1 and thus will not be used to override algorithm calculations.
• Travel from or to LocationSiteIDs out of bounds (dense)/ Travel not specified in data (sparse) will be considered exactly like unset data

Definition of ShiftPlanner-Types

ShiftPlanner-Metainformation

Examples:

{
  "dateFrom": "2019-12-03",
  "dateTo": "2019-12-03"
}

{
  "dateFrom": "2019-12-03",
  "dateTo": "2019-12-03",
  "resCategory": false,
  "resQualification": false,
  "accuracyMode": 1.0,
  "outputLanguage": 1,
  "minQualificationOfTaskCoverage": 2,
  "omnipresentCategoriesOfTaskCoverage": [3,5,6],
  "enablePlanSplitting": false,
  "allowUnassignedTasks": true,
  "followBiorhythm": true,
  "minConcurrentSolutions": 1
}

JSON-Schema

Notes

• The options res* describe which fields from the dataset should be taken into account. More precisely those are:
  • resCategories: categories (Task), categories (Worker), exchangeableCategories, prefCategories, desiredCategory, prefWeekCategories, prefWeekendCategories, omnipresentCategoriesOfTaskCoverage
  • resQualification: minQualificationOfTaskCoverage, qualification (Task), qualification (Worker)

• Using the option allowUnassignedTasks enables an "unassignment behavior" in the algorithm, meaning it will, if deemed necessary, refuse to assign subsets of tasks to any worker. Examples are scenarios where the only qualified workers are overloaded or there is no workers that can even carry out a task. In the output data this can be recognized by the task missing its assignment data, such as timeScheduled or finalassignedOrder. The differences to an assigned task are noted in the description for the Assigned ShiftPlanner-Task. Additionally, the info section will notify of unassignment and, if possible, the reason for it.

ShiftPlanner-Optimization-Parameters

Examples:

{}

{
  "preset": 1,
}

{
  "preset": 1,
  "fairDistribution": 4,
  "timeliness": 5,
  "workerPrefs": 5,
  "teamPrefs": 5,
  "taskPrefs": 5,
  "worktimePrefs": 5,
  "workerReduction": 1,
  "genderPref": 2,
  "profitability": 3
}

JSON-Schema

All parameters are integer numbers between 0 and 9 (inclusive). You only need to pass the ones you want to use, the other will be implicitly set to 0.

The following presets are currently available (parameters not listed are set to 0):

Unassigned ShiftPlanner-Task

Examples:

{
  "taskID": 200,
  "date": "2019-12-03",
  "duration": 240,
  "timeEarliest": "06:00",
  "timeLatest": "12:00"
}

{
  "taskID": 200,
  "externalID": "id123",
  "date": "2019-12-03",
  "duration": 240,
  "timeEarliest": "06:00",
  "timeLatest": "12:00",
  "timePriority": 2,
  "prefWorkers": [1,2],
  "antiWorkers": [5,6],
  "forbWorkers": [3,4],
  "qualification": 3,
  "categories": [1],
  "exchangeableCategories": [2,4],
  "preassignedWorker": 2,
  "desiredWorker": 2,
  "prefGender": 1,
  "precedingTasks": [1,2],
  "predecessorTasks": [1,2],
  "group": 2,
  "groupOrder": 3,
  "revenue": 2.123,
  "initassignedShift": 4,
  "assignmentPriority": 2
}

JSON-Schema

The unassigned task is the incoming task description for the optimizer outlining the restrictions for the optimization.

Restrictions

• groupOrder requires group

Notes

• Tasks within the same group (identical groupID) will still need a Shift each where they will be assigned on seperately. If the whole group or a subset of a group shall be assigned to a single Shift, each task in the set/ subset needs to have a unique groupOrder. The tasks will then be assigned to a single Shift in that order. Tasks without groupOrder within the same group will not get assigned to that Shift and need a different Shift each. Note that there can obviously be only one such subset per group.

• If tasks are supposed to be on the same worker in a specified order but on different Shifts, set the groupID but use precedingTasks or predecessorTasks instead of groupOrder.

Assigned ShiftPlanner-Task

Examples:

{
  ... // See Unassigned ShiftPlanner-Task
  "timeScheduled": "13:45",
  "assignedWorker": 2,
  "assignedShift": 1,
  "info": "text",
  "finalassignedOrder": 1, 
  "profit": 1.123
}

{
  ... // See Unassigned ShiftPlanner-Task
  "info": "text"
}

The json schema for the Assigned ShiftPlanner-Task extends the schema of the Unassigned ShiftPlanner-Task by all the fields marked "Extension" in the table below:

• JSON-Schema
• JSON-Schema

The assigned task - after the performed optimization - extends the unassigned tasks with information about when the task is scheduled and by whom it will be completed.

Unassigned ShiftPlanner-Worker

Examples:

{
  "workerID": 1
}

{
  "workerID": 1,
  "externalID": "id123",
  "qualification": 1,
  "categories": [1,2],
  "desiredCategory": 12,
  "prefCategories": [3],
  "prefWeekCategories": [2],
  "prefWeekendCategories" : [3],
  "prefWorkers": [5,43],
  "antiWorkers": [5,43],
  "shifts": [
    {
      "shiftID": 1,
      "shiftStart": "05:00",
      "shiftEnd": "12:00",
      "shiftDate": "2019-12-03"
    }
  ],
  "gender": 1,
  "expectedWorkingMinutes": 9200,
  "minWorkingMinutes": 8000,
  "maxWorkingMinutes": 12000,
  "maxConsecutiveWorkdays": 6,
  "minConsecutiveWorkdays": 6,
  "prefConsecutiveWorkdays": 6,
  "carryoverConsecutiveWorkdays": 0,
  "maxConsecutiveOffdays": 2,
  "minConsecutiveOffdays": 2,
  "prefConsecutiveWorkdays": 10,
  "prefConsecutiveOffdays": 15,
  "carryoverConsecutiveOffdays": 1,
  "minBreakMinutesBetweenTasks": 600,
  "maxDailyWorkingMinutes": 600,
  "minFreeSaturdays": 4,
  "minFreeSundays": 5,
  "maxWeeklyWorkingMinutes": 3000,
  "carryoverWorkingMinutesLastWeek": 50,
  "maxTwoWeekWorkingMinutes": 4800,
  "carryoverWorkingMinutesSecondLastWeek": 2100,
  "dontVary": true,
  "costsPerMinute": 1.123,
  "costsInitial": 100.12,
  "precTaskDate": "2019-12-02",
  "precTaskScheduled": "12:00",
  "precTaskDuration": 120,
  "precNightShifts": 2,
  "maxOrderedGroups": 2,
  "maxDesiredOrderedGroups": 1,
  "maxNightShifts": 3,
  "maxDesiredNightShifts": 2,
  "minFreeWeekends": 2,
  "minDesiredFreeWeekends": 1,
  "maxConsecutiveSameTaskStart": 1,
  "maxDesiredConsecutiveSameTaskStart": 1,
  "maxWeeklyWorkingDays": 1,
  "prefWeeklyWorkingDays": 1,
  "carryoverWorkingDaysLastWeek": 12
}

JSON-Schema

The worker has both optional and required parameters as marked in the following table.

Restrictions

• Only one of carryoverConsecutiveWorkdays and carryoverConsecutiveOffdays is allowed
• Only one of maxConsecutiveSameTaskStart and maxDesiredConsecutiveSameTaskStart is allowed

Notes

• A worker with dontVary set to true is "fixed" for the optimizer, meaning they get assigned all tasks that have a shift of this worker as their initassignedShift and nothing else. The worker and its tasks will still be considered in ShiftPlanner-Statistics and ShiftPlanner-Info.

• Categories specified in desiredCategory, prefCategories, prefWeekCategories, prefWeekendCategories are automatically considered valid as if they're listed in categories.

• The parameter precNightShifts is used for carrying over the biorhythm between different, consecutive plans. As such, the tasks on the days directly before the plan start are relevant. As an example, let the plan start on 2020-05-01:

  • If on 2020-04-30 no task was scheduled or a task was scheduled that did not overlap with the midnight to 2020-05-01, the value has to be 0.
  • If on 2020-04-30 a task was scheduled that overlaps with midnight to 2020-05-01, the value has to be at least 1; exactly 1 if this is not true for 2020-04-29.
  • If, additionally to the case above, on 2020-04-29 a task was scheduled that overlaps with midnight to 2020-04-30, the value has to be at least 2; exactly 2 if this is not true for 2020-04-28.
  • And so on...

• If either precTaskDate, precTaskScheduled, or precTaskDuration is set, all of the values have to be set. If precNightShifts is set, all of the three mentioned values have to be set as well.

• (v2.32.0) Please note the following behavior regarding minFreeWeekends/minDesiredFreeWeekends:

  • If the last day of the plan is a Saturday, that weekend will not count as a "free weekend".
  • If the first day of the plan is a Sunday, data from precTaskDate will get used to determine if this starting weekend can be "free" or not. If precTaskDate if is earlier than the Saturday and nothing is assigned on Sunday, the weekend is considered a "free weekend" for this plan, if either the precTaskDate is the Saaturday or a task is assigned on Sunday, it is not. If no precTaskDate is given, the weekend will not count as a "free weekend" regardless.

Assigned ShiftPlanner-Worker

The assigned worker - after the performed optimization - extends the unassigned workers with information in the info field.

Examples:

{
  ... // Same as Unassigned ShiftPlanner-Worker
}

{
  ... // See Unassigned ShiftPlanner-Worker
  "info": "text"
}

The json schema for the Assigned ShiftPlanner-Worker extends the schema of the Unassigned ShiftPlanner-Worker by all the fields marked "Extension" in the table below: JSON-Schema.

ShiftPlanner-Statistics

Examples:

{
  "impact": [
    {
      "label": "Minimum consecutive offdays",
      "value": 0.777778
    }
  ],
  "timeWindowViolationTaskIDs": [1,2,3],
  "unassignedTaskIDs": [1,2,3],
  "unassignableTaskIDs": [2,3,4]
}

JSON-Schema