Create a vehicle (by license plate and state)
POST/api/vehicles/create/by-license
Create a vehicle in the Ownli System. This method requires the caller to pass the license plate number and the license plate state. If Ownli does not find a VIN match for this, the vehicle will not be created.
Request
Header Parameters
Partner Id
Client Id
Client Secret
- application/json
Body
required
User's cell phone number used when creating the user.
License plate number.
2 Letter State code for the state in which License plate is registered.
Possible values: >= 1
Current Mileage of vehicle.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 500
The vehicle object created.
- application/json
- Schema
- Example (from schema)
Schema
Id of the vehicle
License plate number
Photo of Vehicle
Make of the vehicle
Model of the vehicle
VIN of the vehicle.
2 Letter State Code (eg. AL, CA, CO etc.)
Year vehicle was built.
Time at which vehicle was added to the system
Last updated timestamp
User id of the owner
Phone number of the owner
{
"id": "string",
"license": "string",
"photoUrl": "string",
"make": "string",
"model": "string",
"vin": "string",
"state": "string",
"year": "string",
"dateAdded": "string",
"updated": "string",
"userId": "string",
"customerPhoneNumber": "string",
"active": true
}
Invalid parameters or invalid state code passed in address. Possible error codes
-
ERROR_INVALID_STATE_CODE
-
ERROR_INVALID_PARAMETERS
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
Authorization error e.g. due to an invalid or missing API keys.
Forbidden. Possible error codes
-
ERROR_NO_PERMISSIONS_TO_RESOURCE
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
User not found. Possible error codes
-
ERROR_USER_NOT_FOUND
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
Vehicle with same License Plate and State exists. Possible error codes
-
ERROR_VEHICLE_ALREADY_EXISTS
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
Internal error. Possible error codes
-
INTERNAL_SERVER_ERROR
-
ERROR_NO_VIN_MATCH
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}