Wialon for developers User guide API reference apps list

list

To get the list of available apps, use the apps/list method.

This method is available only in Wialon Hosting.

Endpoint

Copied!
svc=apps/list&params={
  "manageMode": <uint>,
  "filterLang": <text>
}

Parameters

You can use the following optional parameters in the request:

Parameter Description
manageMode Mode of the request:

  • 0 (default): get the apps available to the current user;
  • 1: get all the apps of the service with all their parameters. This mode is available only to the top user of the service. For other users, the default mode is used.
filterLang Language of the interface, for example, "en". The response contains only the apps that are available for this language. The parameter is used only if manageMode is 0.

The list contains the apps added to the service and the apps from the Library tab of the Apps configurator window in CMS Manager.

Response

If the request is completed successfully, the response is returned in the following format:

Copied!
[
  {
    "name": <text>,                  /* App name */
    "description": <text>,           /* App description */
    "url": <text>,                   /* App URL */
    "flags": <uint>,                 /* App flags */
    "sortOrder": <int>,              /* Sort order */
    "serviceName": <text>,           /* Name of the app service without the "app." prefix */
    "id": <long>,                    /* App ID */
    "langs": <text>,                 /* Languages of the interface */
    "requiredServicesList": <text>,  /* Required services */
    "billingPlans": <text>           /* Billing plans */
  },
  ...
]

The id, langs, requiredServicesList, and billingPlans parameters are returned only if manageMode is 1. For the apps from the library, id is 0. For the values of flags, see Flags.

If the request fails, an error code is returned.

Error codes

Error code Description
7 Access denied: the service isn’t Wialon Hosting, or the account of the current user isn’t found.

If you find a mistake in the text, please select it and press Ctrl+Enter.