Core - Configuration

This module handles the retrieval of the different parameters that can be used to configure the platform and their modules.

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

/api/admin

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

Get map setting data

Gets the configuration data for map settings:

GET /v1/config/map

Gets the configuration data for map settings

Status Codes

Returns a positive Json object containing the map setting data, as specified in the related configuration variables:

{
  BingMapsCredentials: "",      // String
  GoogleMapsCredentials: "",    // String
  MapGenericUrlFormat: "",      // String
  MapGenericAttribution: "",    // String
  DefaultMapCenterLon: 0,       // Double
  DefaultMapCenterLat: 0,       // Double
  DefaultMapZoom: 0             // Int
}

Get frontend configurations

Gets the environment variable configurations for frontend UI

GET /v1/config/frontend-config

Gets the frontend configurations list

Status Codes

Returns a positive Json object containing the frontend configurations:

{
  DefaultLanguage: "en",         // String
  Languages: "['en','it'...]",   // String array
  AuthenticatedSessionsLimit: 6, // Int
  PlatformTitle: "Movens",       // String
  MaxTRAdvanceHours: 3,          // Int, number of hour in advance a reservation can be made
  MaxTRDurationHours: 5,         // Int, max number of hour a reservation can last
  MaxMARevokeMinutes: 30         // Int (nullable), time interval to allow reservation revoke after its creation
}

Get modules

Gets the list of modules announced on the system:

GET /v1/config/modules

Gets the list of modules announced on the system

Status Codes

Returns a list of all the modules:

[
  {
    ID: 1234,                                 // Int
    Name: "Business",                         // String
    LastAnnounced: "2001-01-01T01:01:01Z",    // DateTime
    Version: "1.0.0-50dfe375",                // String
    RingId: "abc"                             // String
  },
  ...
]

Download modules

Gets the list of modules announced on the system and the frond-end version as an Excel file:

POST /v1/config/modules/download-excel

Gets the modules list within frontend version as an Excel file

Status Codes

Returns an excel file with the list of modules announced on the system and the frond-end version.

Get environment variables

Get the environment variables related to the Core 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
POST /v1/config/mappings

Exports a new value for the specified environment variable

Status Codes

Returns a Json positive response and environment variables list for the Core module:

[
  {
    Key: "VariableName",      // String
    Value: "VariableValue"    // String
  },
  ...
]