Vehicle - Config
The Admin interface handles web service calls from the Admin web gui. The base url for this is at:
/api/vehicle-admin
A JSON file with OpenAPI data about all vehicle-related admin APIs can be downloaded here
.
Get environment variables
Get the environment variables related to the Vehicle module (it’s a Paged List APIs, as explained in the introduction):
- GET /v1/config/mappings
Returns the environment variables relating to the current module
- Status Codes
200 OK – Success
Returns a Json positive response and environment variables list for the Vehicle module:
[
{
Key: "VariableName", // String
Value: "VariableValue" // String
},
...
]
Get frontend configurations
Gets the environment variable configurations for APP
Returns a positive Json object containing the frontend configurations:
{
DefaultEngineType: 1, // Int
MAMinExtensionMinutes: 15, // Int
MAMaxExtensionMinutes: 2880, // Int
MAMaxExtensionAdvanceMinutes: 1 // Int
}
where:
DefaultEngineType
specifies the default value for a new vehicle’s engine type, as per the VehicleEngineTypes enumeration.
MAMinExtensionMinutes
specifies the minimum duration - in minutes - for a reservation extension
MAMaxExtensionMinutes
specifies the maximum duration - in minutes - for a reservation extension
MAMaxExtensionAdvanceMinutes
specifies the grace time prior of the reservation expected end in which the user is allowed to request an extension