Route

Get Data From Master Route

Query Parameters

status array

Route Status (active, archive) (can be both) (optional)

Responses

• 200
• 400
• 401

---

Success

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
data object[]
Array [
routeName string required
routeId number required
routeStatus string required
mileage number required
mainRoute string[] required
alternateRoute string[] required
]

{
  "message": "string",
  "data": [
    {
      "routeName": "string",
      "routeId": 0,
      "routeStatus": "string",
      "mileage": 0
    }
  ]
}

{
  "message": "Success",
  "data": [
    {
      "routeName": "Route 1",
      "routeId": 1,
      "routeStatus": "Active",
      "mileage": 1.11,
      "mainRoute": [
        "Geofence 1",
        "Geofence 2"
      ],
      "alternateRoute": []
    },
    {
      "routeName": "Route 2",
      "routeId": 2,
      "routeStatus": "Archive",
      "mileage": 1.23,
      "mainRoute": [
        "Geofence 1",
        "Geofence 3"
      ],
      "alternateRoute": [
        "Geofence 1",
        "Geofence 2",
        "Geofence 3"
      ]
    }
  ]
}

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