get_account_data

To get detailed information about an account, use this signature of the account/get_account_data method:

Copied!
svc=account/get_account_data&params={"itemId":<long>,
                                     "type":<uint>}

For information about several accounts, use the following signature:

Copied!
svc=account/get_account_data&params={"itemId":[<long>],
                                     "type":<uint>}

Parameters

The request can contain the following parameters. The required parameters are marked with an asterisk (*).

Parameter Description
itemId* Resource (account) ID.
type Response flag. Types of response:
  • 1 — minimal information, usually required to estimate the state of the logged user;
  • 2 — detailed information with combined, personal and billing plan settings;
  • 4 — excludes subordinate accounts from usage. The information concerns only the current account;
  • 8 — details on personal sites.
  • Response

    If the request is completed successfully, the response for a single account is as follows:

    Copied!
    {
        "parentAccountName":<text>, /* Parent account name. */
        "parentAccountId":<long>,   /* Parent account ID. */
        "parentEnabled":<bool>,       /* Parent account is: 1 — available, 0 — blocked. */
        "plan":<text>,        /* Billing plan name. */
        "enabled":<int>,  /* State: 0 — blocked, 1 — active. */
        "flags":<uint>,       /* Flags - duplicates flags from billing plan settings. */
        "created":<unit>, /* Account creation time, UNIX-time. */
        "balance":<text>, /* Balance (with currency). */
        "daysCounter":<uint>, /* Counter of days. */
        "settings":{
            "balance":<double>,   /* Balance. */
            "plan":{        /* Billing plan settings. */
                "flags":<uint>,       /* Billing plan flags (see below). */
                "blockBalance":<int>, /* Minimum balance for the account to be active. */            "denyBalance":<int>,  /* deny balance */
    
                "minDaysCounter":<int>,   /* Minimum number of days. If a lower number of days is left, the account is blocked. */
                "historyPeriod":<uint>,   /* Period during which messages are stored. If 0 is specified, the storage period is unlimited. */
                "currencyFormat":"<currency_format>", /* Account currency format. */  
                "services":{        /* List of services. */
                    <text>:{      /* Service name. */
                        "type":<int>,     /* Service type: 1 — on demand; 2 — periodic */
                        "usage":<uint>,       /* Number of created resources in the current service */
                        "maxUsage":<int>, /* Maximum number of resources. */
                        "cost":<text>,        /* Cost table. */
                        "interval":<int>  /* Reset frequency: 0 — none, 1 — hourly, 2 — daily, 3 — weekly, 4 — monthly.*/
                        "descr":"<text>"    /* Billing service description. */ 
                    }
                }
            },
            "personal":{        /* Account (personal) settings. */
                ...         /* Has the same format as billing plan settings. */
            },
            "combined":{        /* Combined settings consisting of billing plan and account settings. */
                ...         /* Has the same format as billing plan settings. */
            }
        },
        "siteAccess":{
                "<service_name>":"<dns_name>",      /* Where the key is a service name and the value is a DNS name */
                ...
                 /* If you use the "type=8" parameter (see above), the object includes the following additional information.*/
                "<service_name>": {
                    "n":"<dns_name>", /* Where the value is a DNS name. */
                    "tt":"<template_type>", /* Where the value is a site template type (wialon_web, cms_manager.) */
                    "b":"<branch>", /* Site branch (v1311, master, develop,v1408). */
                    "sp":<int>, /* SSL port. */
                    "force_https":"<force_https>", /* Site custom property "force_https". */
                    "ignore_in_cms_login_as":"<ignore_in_cms_login_as>" /* Site custom property "ignore_in_cms_login_as". */
                }
                ...
        },
        "serviceKeys":{ /* External map providers. */            "name":"<text>",  /* Map key name.*/
                "type":<int>,         /* Key type. */
                "provider":"<text>" /* Map provider name. */
        },
        "managable":<int>,    /* Allow managing the account specified in the request: 1 — yes, 0 — no. */
        "dealerRights":<int>, /* Allow using dealer rights for the billing plan of the specified account: 0 — no, 1 — yes. */
        "subPlans":[<text>]   /* Array of subordinate billing plans. */
    }
    
    

    The response for several accounts is structured as follows:

    Copied!
    {
        "<account_id1>": {  /* Requested account ID. */
            ...                 /* Account information (see above). */
        },
        "<account_id2>": {  /* Requested account ID. */
            ...                 /* Account information (see above). */
        },
        ...
    }
    

    Service key types

    Type Description
    0x01 Protected key (Gurtam key).
    0x02 Routing key.
    0x04 Geocoding key.
    0x08 Distance matrix key.
    0x10 Map tiles key.

    Account flags

    Flag Description
    0x01 Block users, if the balance is lower than the blocking threshold.
    0x02 Forbid login to the system and stop account functioning if the balance is less than the blocking threshold.
    0x20 Decrease the number of days in the day counter, and block the account when the number of remaining days reaches the minimum.
    0x40 Redefine billing plan flags.
    0x04 Allow unknown services.

    Services list

    Service Type Description
    avl_resource periodic Activates the Accounts section in CMS Manager; defines the quantity and cost of resources and accounts.
    avl_retranslator periodic Activates the Retranslators section in CMS Manager and defines the allowed quantity and cost of retranslators.
    avl_route periodic Activates the Routes module. Enables the Routes tab and associated reports and notifications.
    avl_unit periodic Activates the Units section in CMS Manager and the Units tab in the monitoring system. Defines the cost and quantity of units.
    avl_unit_group periodic Activates the Unit groups section in CMS Manager and Units tab in the monitoring system. Defines the cost and quantity of unit groups.
    cms_manager on demand Grants access to CMS Manager.
    create_units on demand Activates the button to create units in the Units section in CMS Manager and the Units tab in the monitoring system.
    create_users on demand Activates the button to create users in the Users section in CMS Manager and the Users tab in the monitoring system.
    create_unit_groups on demand Activates the button to create unit groups in the Unit groups section in CMS Manager and the Unit groups tab in the monitoring system
    create_resources on demand Activates the button to create resources and accounts in the Resources section in CMS Manager.
    custom_fields periodic Activates the Custom fields tab in the properties of units, users or groups. Defines the cost and quantity (summarized, by objects of different types) of custom fields; does not affect drivers and trailers.
    custom_reports on demand Activates advanced reports: reports on unit groups, users, drivers, trailers as well as groups of drivers and trailers (except the Log table for users and unit groups). Works within the Reports module.
    drivers periodic Activates the Drivers module and defines the cost and quantity of drivers. If disabled, the Drivers tab is not shown and mentions of drivers disappear from notifications, user settings, and SMS dialog.
    driver_groups periodic Defines the quantity and cost of driver groups. Works within the Drivers module.
    email_notification on demand Enables sending notifications by e-mail. The recommended limitation is 10 reports an hour (to avoid server overloading).
    email_report on demand Enables sending a report by e-mail (within the Jobs module). The recommended limitation is 10 reports an hour (to avoid server overloading).
    google_service on demand Activates Google services.
    import_export on demand Activates the Import/Export features on monitoring sites.
    jobs periodic Activates the Jobs tab. Defines the cost and the allowed number of jobs.
    locator on demand Activates the Locator option in the user menu.
    messages on demand Grants access to the Messages tab.
    net_access (outdated) on demand Allows authentication through the service connector in Wialon Pro.
    notifications periodic Activates the Notifications tab and defines the cost and the allowed number of notifications.
    orders periodic Activates access to the Logistics application and allows running the Orders report on units and drivers in the monitoring system.
    pois (outdated) periodic Activates the POI panel and defines the cost and allowed quantity of POIs.
    reports on demand Activates the Reports module and defines the cost and the allowed quantity of report templates. If disabled, associated jobs and notifications disappear and the trip detector can’t be used.
    retranslator_units periodic Defines the number of available units attached to activated retranslators.
    rounds periodic Defines the number of allowed rounds and their cost (within the Routes module).
    route_schedules periodic Defines the number of allowed schedules and their cost (within the Routes module).
    sdk on demand Grants access to Apps.
    service_intervals periodic Defines the cost and quantity of service intervals. If activated, the Service intervals tab appears in the unit properties. Allows registering events of the Maintenance type, run reports and receive notifications about maintenance.
    sms on demand Determines the allowed quantity of SMS messages and their cost.
    tacho on demand Activates the Driver activity and Violations tables in reports on drivers.
    storage_user periodic Activates the Users tab and defines the cost and quantity of users.
    trailers periodic Activates the Trailers tab and defines the cost and quantity of trailers.
    trailer_groups periodic Defines the quantity and cost of trailers; works within the Trailers module.
    unit_commands periodic Activates the Commands tab in the unit properties. Defines the quantity (for all units in total) and cost of commands.
    unit_sensors periodic Defines the number of sensors (calculated for all units in total) and their cost.
    user_notifications periodic Enables receiving notices from the administrator of the service.
    Wialon_activex (outdated) on demand Grants remote access to the system via SDK, ActiveX.
    wialon_mobile (outdated) on demand Activates access to the application for Android and iOS.
    wialon_mobile2 on demand Activates access to the application for Android and iOS. Requires the wialon_mobile service enabled.
    wialon_sdk on demand Grants remote access to the system via SDK.
    zones_library periodic Activates the Geofences module and defines the cost and quantity of geofences. If disabled, the Geofences tab is not shown, and any mention of geofences disappears from reports and user settings.
    zone_groups periodic Activates groups of geofences.
    AgroService (outdated) Type Description
    agroplots periodic Plots
    agroplotgroups periodic Groups of plots
    agrocrops periodic Crops
    agromachines periodic Machines
    agroequipments periodic Equipment
    agrocultivationtypes periodic Cultivation types

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

    Report a mistake

    Your message was sent. Thank you!

    An error occurred while submitting the form

    Download PDF file
    Download Word document

    See also