Create Route Planning

Create New Route Planning

application/json

application/x-www-form-urlencoded

Request Body

routeId string required
vehicleId string required
startSchedule date-time required

Request Body

routeId string required
vehicleId string required
startSchedule date-time required

Responses

• 200
• 400
• 401

---

Success

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
data object
id number required
information string required

{
  "message": "string",
  "data": {
    "id": 0,
    "information": "string"
  }
}

{
  "message": "Success",
  "data": {
    "route": null,
    "vehicle": null,
    "routeRecordId": 1,
    "routeId": 1,
    "vehicleId": 1,
    "companyId": 1,
    "expectedStartOn": "2045-05-31T00:18:00.000Z",
    "expectedEndOn": "2045-05-31T00:24:34.000Z",
    "distanceDriven": null,
    "startOn": null,
    "endOn": null,
    "status": "scheduled",
    "missedRoutes": null
  }
}

Bad Request

application/json

Schema

Example (from schema)

Expired Token

Bad Token

---

Schema

code string
message string
detail string

{
  "code": "string",
  "message": "string",
  "detail": "string"
}

{
  "code": "E-V1/1-03",
  "message": "An error occurred while executing query",
  "detail": "Context creation failed: jwt expired"
}

{
  "code": "E-V1/1-03",
  "message": "An error occurred while executing query",
  "detail": "Context creation failed: jwt malformed"
}

Unauthorized Request

application/json

Schema

Example (from schema)

Example

---

Schema

code string
message string

{
  "code": "string",
  "message": "string"
}

{
  "code": "E-G1/1-01",
  "message": "Authentication token is required"
}

Loading...