Route Planning

Get Data From Route Planning

Query Parameters

status string[]

Ex [scheduled,ontheway,done,canceled]

vehicle number[]

Ex [112,113]

Responses

• 200
• 400
• 401

---

Success

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
data object[]
Array [
routePlanningId number required
vehicleId number required
licensePlate string required
planningStatus string required
routeName string required
startSchedule string required
endSchedule string required
mainRoute string[] required
alternateRoute string[] required
actualStart date-time required
actualEnd date-time required
actualDistance number required
]

{
  "message": "string",
  "data": [
    {
      "routePlanningId": 0,
      "vehicleId": 0,
      "licensePlate": "string",
      "planningStatus": "string",
      "routeName": "string",
      "startSchedule": "string",
      "endSchedule": "string",
      "actualStart": "2024-10-25T02:47:31.531Z",
      "actualEnd": "2024-10-25T02:47:31.531Z",
      "actualDistance": 0
    }
  ]
}

{
  "message": "Success",
  "data": [
    {
      "vehicleId": 1,
      "licensePlate": "L 123 TES",
      "planningStatus": "Scheduled",
      "routeName": "Jakarta-Surabaya",
      "startSchedule": "2024-05-14T00:00:00.000Z",
      "endSchedule": "2024-05-14T03:26:54.000Z",
      "mainRoute": [
        "Jakarta",
        "Surabaya"
      ],
      "alternateRoute": [
        "Jakarta",
        "Jogjakarta",
        "Surabaya"
      ],
      "actualStart": "2024-05-14T00:00:00.000Z",
      "actualEnd": "2024-05-14T03:26:54.000Z",
      "actualDistance": 45.6
    }
  ]
}

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...