Error Structure

{
	"code": "domain_error",
	"message": "Error description"
}

Attribute	Description	Required
code*	It is composed of the domain that is handling the request as a prefix and a short description or type of the error in snake case.	true
message*	A human-readable description of what is causing that error.	true
reasons	The details of the error caused. Ex: DRIVERS_LICENSE_INVALID for a customer's invalid driver's license. Check the domain error section for more details and how to treat it	false
param	Used to identify the invalid param passed via request. Ex: customerUUID	false

Validation error example

{
	"code":"rental_validation_error",
	"message":"Validation error",
	"param": "customerUUID"
}

Customer

Customer is validated on customer creation and update.

Validation Error

{
   "code":"customer_request_validation",
   "message":"*message",
   "errors":[
      {
         "property":"*propertyName",
         "message":"*errorMessage"
      }
   ],
   "reasons":[
      "FAILURE_REASON"
   ]
}

customer request validation messages

message	reason	errorMessage
Payload is invalid	Payload validation failed
Payload can not be read	Property is missing	Property must be provided
Required request body is missing	Request Body is empt
JSON parse error	Wrong json format

Authorization Error

{
	"code":"customer_unauthorized",
	"message":"Unauthorized"
}

System Error

{
	"code":"customer_internal_server_error",
	"message": "Internal server error"
}

Rental

Driver Checks Error

Driver Checks are performed during create reservation and start rental requests and validate the data of customers persisted previously during the creation process, by our partners.

Driver Check Error Example

{
	"code":"rental_driver_check",
	"message":"Driver check error",
	"reasons":[
		"DRIVERS_LICENSE_INVALID",
		"TNC_NOT_ACCEPTED"
	]
}

Driver Check Failed Reasons

Driver Check (409)	Instruction to the user
DRIVERS_LICENSE_INVALID	Check your driver's license data
DRIVERS_LICENSE_EXPIRED	Update your driver's license data
MIN_AGE_NOT_REACHED	This vehicle is not available for drivers under 21
TNC_NOT_ACCEPTED	Read and confirm our Terms and Conditions

Criteria Not Met Error

Every single end rental request is submitted to a vehicle check, that checks every criteria that secures the vehicle before starting the process of ending a rental.

End Rental Criteria Not Met Error Example

{
	"code":"rental_criteria_not_met",
	"message":"Criteria not met",
	"reasons":[
		"CARKEY"
	]
}

End Rental Criteria Reasons

Open End Rental Criterium (409)	Instruction to the user
IGNITION	Turn off the ignition
KEY_IN_IGNITION	Remove the key from the ignition and return it to the keyholder
CARKEY	Return the key to the keyholder
OUTOFAREA	Return the vehicle to the business area
FUELCARD	Return the fuel card to the cardholder
PARKCARD	Return the parking card to the cardholder
LIGHTS	Turn off the lights
HANDBRAKE	Pull up the hand brake
WINDOW_LEFT	Close the front left window
WINDOW_LEFT_REAR	Close the rear left window
WINDOW_RIGHT	Close the front right window
WINDOW_RIGHT_REAR	Close the rear right window
SUNROOF	Close the sunroof
DOOR_LEFT	Close the front left door
DOOR_LEFT_REAR	Close the rear left door
DOOR_RIGHT	Close the front right door
DOOR_RIGHT_REAR	Close the rear right door
TRUNK	Close the trunk
VEHICLE_NOT_CONNECTED	Wait a bit. If the status persists, please call us.
GEAR_POSITION	Put the gear in the Park (P) position.
VEHICLE_BLOCKED_BY_PHYSICAL_KEY	Please, return the physical key to the holder and let the vehicle doors unlocked

Vehicle Not Available

The api will throw the error code: RENTAL_VEHICLE_NOT_AVAILABLE in the following situation:

The vin informed contains a invalid hardware type for partner
The vehicle is disconnected
The vehicle is not in a rentable (green) state.

Geolocations

All geolocation data is served statically. The only error code to expect is a 404, if the API user made a mistake with the path, i.e. by using a non-existing location name. The 404 error body is a "The specified key does not exist." message, returned in xml format, independent of the accept header.