System Languages¶

Retrieve a list of available languages¶

GET /api/v1/system/languages/¶

Example request:

GET /api/v1/network/languages/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "defaultLanguage": "English"
   "availableLanguages": [
      {
          "name": "French",
          "locale": "fr",
          "encoding": "UTF-8",
      }
   ]
}

Response JSON Object:

defaultLanguage (string) – The default language.
availableLanguages (array) – An array of available languages. See Language instance.

Status Codes:

200 OK – no error

It is controlled via the following configuration settings:

"USER_LANGUAGES" : ["English", "Flemish", "French"],
"FILTER_LANGUAGES": false

With following parameters:

USER_LANGUAGES: Is the list of supported languages. It MUST of course be inline with what the Application Server supports. Used in case FILTER_LANGUAGES is True.
FILTER_LANGUAGES: If it is True (default is False) the the list of languages returned by the AS to return only the ones present in USER_LANGUAGES. It is useful mainly if test languages are defined in the AS that dies not need to be exposed to the users.

Local Objects¶

Language instance¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the language. It has to be used in any API having a language as parameter
language_code	String	O \| The associated language code. See Language and language code.
locale	String	O \| Locale associated to this language (from the AS). Usually in the format xy or xy_ab.
encoding	String	O