Vehicle - Configuration

This module handles the retrieval of the different parameters that can be used to configure the APP.

The base url for the APIs in this page is at:

/api/vehicle-mobile

A JSON file with OpenAPI data about all core-related mobile APIs can be downloaded here.

Get mobile configurations

Gets the environment variable configurations for APP

GET /v1/config/mobile-config

Gets the mobile configurations list

Status Codes

• 200 OK – Success

Returns a positive Json object containing the frontend configurations:

{
  VehicleAllocationRangeMinutes: 60,    // Int
  DeviceBTKeyKeepAliveMinutes: 15,      // Int
  MinDamageAttachments: 1,              // Int (nullable)
  MaxDamageAttachments: 10,             // Int (nullable)
  MAMaxExtensions: 1,                   // Int
  MAMinExtensionMinutes: 15,            // Int
  MAMaxExtensionMinutes: 2880,          // Int
  MAMaxExtensionAdvanceMinutes: 1       // Int
}

where:

• VehicleAllocationRangeMinutes specifies how many minutes prior of the nominal trip start a vehicle will be assigned to the movement authority

• DeviceBTKeyKeepAliveMinutes specifies for how many minutes the APP should allow the user to send doors BT commands to the vehicle on board device

• MinDamageAttachments if set specifies the minimum number of attachments allowed for a damage report

• MaxDamageAttachments if set specifies the maximum number of attachments allowed for a damage report

• MAMaxExtensions specifies how many extensions are allowed per reservation

• 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