Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.solvice.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Service Appointments

Schedule technicians for home services with time windows and skill matching.

​
Request

{
  "resources": [
    {
      "name": "technician-1",
      "shifts": [{
        "from": "2024-03-15T08:00:00Z",
        "to": "2024-03-15T17:00:00Z",
        "start": {"latitude": 40.7128, "longitude": -74.0060},
        "end": {"latitude": 40.7128, "longitude": -74.0060},
        "breaks": [{
          "type": "WINDOWED",
          "from": "2024-03-15T12:00:00Z",
          "to": "2024-03-15T13:00:00Z",
          "duration": 2700
        }]
      }],
      "tags": ["plumbing", "electrical", "hvac"]
    },
    {
      "name": "technician-2",
      "shifts": [{
        "from": "2024-03-15T08:00:00Z",
        "to": "2024-03-15T17:00:00Z",
        "start": {"latitude": 40.7128, "longitude": -74.0060},
        "end": {"latitude": 40.7128, "longitude": -74.0060}
      }],
      "tags": ["plumbing", "appliance"]
    }
  ],
  "jobs": [
    {
      "name": "appointment-1",
      "location": {"latitude": 40.7260, "longitude": -73.9897},
      "duration": 5400,
      "windows": [{"from": "2024-03-15T08:00:00Z", "to": "2024-03-15T10:00:00Z", "hard": true}],
      "tags": [{"name": "plumbing", "hard": true}],
      "priority": 100
    },
    {
      "name": "appointment-2",
      "location": {"latitude": 40.7489, "longitude": -73.9680},
      "duration": 3600,
      "windows": [{"from": "2024-03-15T09:00:00Z", "to": "2024-03-15T12:00:00Z", "hard": true}],
      "tags": [{"name": "hvac", "hard": true}]
    },
    {
      "name": "appointment-3",
      "location": {"latitude": 40.7074, "longitude": -74.0113},
      "duration": 2700,
      "windows": [{"from": "2024-03-15T13:00:00Z", "to": "2024-03-15T16:00:00Z", "hard": true}],
      "tags": [{"name": "appliance", "hard": true}]
    }
  ],
  "options": {
    "snapUnit": 900
  }
}

​
Response

{
  "solution": {
    "routes": [
      {
        "resource": "technician-1",
        "jobs": [
          {"job": "appointment-1", "arrival": "2024-03-15T08:00:00Z", "departure": "2024-03-15T09:30:00Z"},
          {"job": "appointment-2", "arrival": "2024-03-15T09:45:00Z", "departure": "2024-03-15T10:45:00Z"}
        ]
      },
      {
        "resource": "technician-2",
        "jobs": [
          {"job": "appointment-3", "arrival": "2024-03-15T13:15:00Z", "departure": "2024-03-15T14:00:00Z"}
        ]
      }
    ]
  }
}

​
Key Features

FeatureUsage
tags on resourceSkills the technician has
tags.hard: true on jobRequired skill for this job
snapUnit: 900Round arrivals to 15-minute intervals
breaks.type: "WINDOWED"Break within a time range