×
 

Module list

This API allows you to get the full list of available modules for an account, including their identifiers and descriptions.

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/ax/api.php?

Request parameters

  • cmd=modlist— command to retrieve the list of modules
  • node — the number of the node where the command should be executed
     

Example request

https://<server_address>/ax/api.php?cmd=modlist&node=1
Response
 
"code": 0,
  "data": [
    {
      "descr": "Fuel Card Module",
      "identifier": 7,
      "name": "fuel"
    },
    {
      "descr": "Engine Lock Module",
      "identifier": 8,
      "name": "lock"
    },
    {
      "descr": "Notification Module",
      "identifier": 27,
      "name": "notification"
    }
  ],
  "msg": "OK"
}
In response to the API request, the following is returned:
  • code— request result code (0 = successful)
  • data— array of module objects:
  • descr— module description
  • identifier— unique module ID
  • name— system name of the module
  • msg— text message describing the result of the request