Model input

The modelInput is where you add your data about available technicians and the visits to be scheduled and optimized.

The JSON shows an example modelInput. Note, most of the values are missing.

{
  "modelInput": {
    "locationSetName": "Belgium",
    "vehicles": [
      {
        "id": "Van"
      }
    ],
    "visits": [
      {
        "id": "Visit A"
      }
    ],
    "visitGroups": [
      {
        "id": "Group 1"
      }
    ],
    "skills": [
      "Plumber"
    ],
    "tags": [
      {
        "name": "First-aid cert"
      }
    ],
    "planningWindow": {
      "startDate": "2027-02-01T00:00:00-04:00",
      "endDate": "2027-02-08T00:00:00-04:00"
    },
    "freezeTime": "2022-02-02T12:15:50-04:00",
    "pinNextVisitDuringFreeze": "ALWAYS"
  }
}

  • locationSet references a pre-calculated location/distance matrix that speeds up processing. If specified, all locations in the model must be a subset of the referenced pre-calculated location set. If unspecified, a new time/distance matrix will be calculated for the request. See locations sets for more details.

  • vehicles contains information about the technicians and the shifts they work. See Vehicle resource constraints for more details.

  • visits contains information about the visits that require a service. See Visit service constraints for more details.

  • visitGroups contains information about visits that must be grouped together. See Multi-vehicle visits for more details.

  • skills allows technicians with the correct skills to be matched with visits that require those skills. See Skills for more details.

  • tags convey additional information about visits and technicians, for instance, whether or not a technician has clearance for a particular job. See Tags for more details.

  • planningWindow is the period of time the schedule is being planned for. See Planning window for more details.

  • freezeTime is the time at which to freeze all visits in the schedule during real-time planning. See Real-time planning: pinning visits for more details.

  • pinNextVisitDuringFreeze controls which visit are pinned during real-time planning when freezeTime is set. See Real-time planning: pinning visits for more details.

Next