• Submit a planning request
      POST
    • Get the status of a planning request
      GET
    • Schemas
      • PlanningInput
      • PlanningSubmittedResult
      • PlanningStatusResult
      • PlanningStatus
      • PlanningResult
      • Issue
      • IssueType
      • WorkOrderAssignmentRuleIntervalUnit
      • PinnedWorkOrderAssignment
      • WorkOrderAssignment
      • Location
      • WorkOrderAssignmentRule
      • PeriodDates
      • Employee
      • Address
      • GeoLocation

    PlanningInput

    {
        "customerCode": "string",
        "start": "2019-08-24T14:15:22.123Z",
        "employees": [
            {
                "id": "string",
                "homeAddress": {
                    "address": "string",
                    "zipCode": "string",
                    "city": "string"
                },
                "homeGeo": {
                    "lat": 0,
                    "lng": 0
                },
                "workHoursMonday": 0,
                "workHoursTuesday": 0,
                "workHoursWednesday": 0,
                "workHoursThursday": 0,
                "workHoursFriday": 0,
                "workHoursSaturday": 0,
                "workHoursSunday": 0,
                "unavailableDates": [
                    {
                        "start": "2019-08-24",
                        "end": "2019-08-24"
                    }
                ]
            }
        ],
        "locations": [
            {
                "id": "string",
                "address": {
                    "address": "string",
                    "zipCode": "string",
                    "city": "string"
                },
                "geo": {
                    "lat": 0,
                    "lng": 0
                }
            }
        ],
        "workOrderAssignmentRules": [
            {
                "locationId": "string",
                "durationInMinutes": 0,
                "workOrderIds": [
                    "string"
                ],
                "priority": 0,
                "interval": 0,
                "intervalUnit": "Week",
                "minimalDaysBetween": 0,
                "expectMaintenance": true,
                "maintenanceDate": "2019-08-24",
                "availableDaysOfWeek": [
                    0
                ],
                "unavailableDates": [
                    {
                        "start": "2019-08-24",
                        "end": "2019-08-24"
                    }
                ],
                "requiredEmployeeIds": [
                    "string"
                ],
                "requiredStartTime": "14:15:22.123Z",
                "lastWorkOrderDateForInterval": "2019-08-24"
            }
        ],
        "pinnedAssignments": [
            {
                "workOrderId": "string",
                "locationId": "string",
                "employeeId": "string",
                "start": "2019-08-24T14:15:22.123Z",
                "end": "2019-08-24T14:15:22.123Z"
            }
        ],
        "holidays": [
            "2019-08-24"
        ]
    }
    Built with