associateVehicleId API Endpoint

This section lists the APIs needed to associate a vehicle Id to a beacon's unique UUID. Before proceeding, please note the following:

• A beacon can be mapped to only one vehicle at a time. However, a vehicle can have more than one beacon associated with it.

• In order to associate an existing beacon with a new vehicle, previous beacon mapping must first be disassociated.

Refer to Zendrive Server APIs for an understanding of how Zendrive server APIs are organized.

associateVehicleId PUT API Details

PUT URL: https://api.zendrive.com/v1/beacon

Beacons can be created and configured with a unique ID using the HTTP PUT method.

Headers

Name	Type	Description
Authorization*	String	API KEY <APIKEY>
Content-Type*	String	application/json

Request Body

Name	Type	Description
uuid*	String	beacon uuid
major*	String	beacon major version
minor*	String	beacon minor version
vehicle id*	String	Associated vehicle (if existing)

201: Created Beacon is created

{
    // Response
}

204: No Content Beacon is updated

{
    // Response
}

400: Bad Request Missing body parameters such as uuid, major, minor, etc,.

{
  "error": "Bad Request with human readable message”
}

403: Forbidden application_id not whitelisted

{
   "error": "Access Denied"
}

409: Conflict Vehicle Id already associated with beacon

{
  “error”: “Vehicle exists”, 
  “vehicleId”: <vehicleId>
}

422: Unprocessable Entity Vehicle Id does not exist

{
  “error”: “VehicleId does not exists”
  “vehicleId”: <vehicleId>
}

401: Unauthorized Wrong, or missing APIKEY Authorization Header

{
   "error": "Unauthorized request"
}

associateVehicleId GET API Details

GET URL: https://api.zendrive.com/<v1>/beacon

Beacons configured with a unique ID can be retrieved using the HTTP GET method.

Headers

Name	Type	Description
Authorization*	String	API KEY <APIKEY>
Content-Type*	String	application/json

Request Body

Name	Type	Description
uuid*	String	Unique beacon Id
major*	String	Beacon major version
minor*	String	Beacon minor version

200: OK Beacon successfully retrieved

{
    // “uuid”:“uuid1”
       “major”:1
       “minor”:
       “vehicle_id”:”vehicle1_id”
    //
}

401: Unauthorized Authorization failure due to wrong or missing APIKEY authorization header

{
    // {"error": "Unauthorized request"}
}

403: Forbidden application_id not whitelisted

{
    // {"error": "Access Denied"}

}

404: Not Found Beacon does not exist

{
    // Response
}

Response Body

{
    // “uuid”:“uuid1”
       “major”:1
       “minor”:
       “vehicle_id”:”vehicle1_id”
    //
}