Route Dispatch API
Introduction
NextBillion.ai’s Route Dispatch API is designed to share any planned route, along with intermediary stops, to drivers registered with NextBillion.ai. Users can dispatch a route to registered drivers by providing their email addresses in the input request. Additionally, users can provide route details like distance, stops, type of the task to be performed at those stops, arrival time and routing characteristics among others.
To dispatch the routes to your drivers, register them at NextBillion.ai Cloud Console.
Once a route is successfully configured using the following endpoint, the driver can get all the details on their Driver app, available on Android & iOS.
Let’s take a look at the available parameters.
Request Parameters
Name | Type | Required | Format and Usage | Description |
---|---|---|---|---|
key | String | Yes | Format: 32 characters alphanumeric string Usage: key=API_KEY | A key is a unique identifier that is required to authenticate a request to the API. |
Request Body
Loading..Response Schema
Loading..Sample Request
Sample Response
API Query Limits
- NextBillion.ai allows a maximum rate limit of 6000 queries per minute or 100 queries/second for continuous requests.
- Note: We can increase the quota if needed on request. Contact [email protected] for more details.
- The maximum number of steps that can be provided in the input are 1000.
arrival
should always be either equal to or greater than the current time and it should increase monotonically for each step.
API Error Codes
Response code | Description | Additional notes |
---|---|---|
200 | Normal success case. | Normal success case. |
400 | Input validation failed. | There is a missing or an invalid parameter or a parameter with an invalid value type is added to the request. |
401 | APIKEY not supplied or invalid | This error occurs when the wrong API key is passed in the request or the key is missing altogether. |
403 | APIKEY is valid but does not have access to requested resources | You might be querying for a geographical region which is not valid for your account or requesting a service which is not enabled for you. |
404 | Requested host/path not found | This error occurs when a malformed hostname is used. |
422 | Could not process the request | A feasible solution could not be generated for the given set of locations or parameter configuration. |
429 | Too many requests | QPM reached or API request count quota reached. |
500 | Internal Service error. | There was an internal issue with NextBillion.ai services. You can reach out to [email protected] for an explanation. |