Wialon para desarrolladores Manual de usuario Documentación de API account get_account_data

get_account_data

Para obtener información detallada sobre una o varias cuentas, utilice el método account/get_account_data.

Endpoint

Para obtener información sobre una cuenta, utilice la siguiente solicitud:

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

Para obtener información sobre varias cuentas, especifique un array de ID:

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

Parámetros

La solicitud debe contener los siguientes parámetros:

Parámetro Descripción
itemId ID de la cuenta o array de ID de cuentas.
type Tipo de información devuelta. Opcional. Por defecto, 2. Los valores se pueden sumar. Valores posibles:
  • 1: información mínima necesaria para evaluar el estado del usuario actual.
  • 2: información detallada con la configuración del plan de facturación, la configuración de la cuenta y la configuración combinada.
  • 4: excluir las cuentas subordinadas de usage. La información se refiere solo a la cuenta especificada.
  • 8: detalles de los sitios. Solo funciona junto con 2, por ejemplo, "type":10. Para obtener más información, consulte Detalles de los sitios.

Respuesta

Si la solicitud para una cuenta se completa con éxito, la respuesta se devuelve en el siguiente formato:

Respuesta
Copied!
{
  "parentAccountName": <text>,  /* Nombre de la cuenta padre. No se devuelve para cuentas de nivel superior. */
  "parentAccountId": <long>,    /* ID de la cuenta padre. No se devuelve para cuentas de nivel superior. */
  "parentEnabled": <int>,       /* Estado de la cuenta padre: 0 (bloqueada), 1 (activa). No se devuelve para cuentas de nivel superior. */
  "plan": <text>,               /* Nombre del plan de facturación. */
  "enabled": <int>,             /* Estado de la cuenta: 0 (bloqueada), 1 (activa). */
  "switchTime": <uint>,         /* Última modificación del estado de la cuenta (marca de tiempo Unix). */
  "created": <uint>,            /* Hora de creación de la cuenta (marca de tiempo Unix). */
  "flags": <uint>,              /* Flags del plan de facturación. Duplica los flags de la configuración del plan de facturación. */
  "balance": <text>,            /* Saldo (con moneda). */
  "daysCounter": <int>,         /* Contador de días. */
  "settings": {                 /* Configuración. */
    "balance": <double>,        /* Saldo. */
    "plan": {                   /* Configuración del plan de facturación. */
      "flags": <uint>,          /* Flags del plan de facturación (consulte Flags de la cuenta). */
      "blockBalance": <double>, /* Saldo por debajo del cual se bloquea la cuenta. */
      "denyBalance": <double>,  /* Saldo por debajo del cual los servicios de pago no están disponibles. */
      "minDaysCounter": <int>,  /* Cantidad de días por debajo de la cual se bloquea la cuenta. */
      "historyPeriod": <uint>,  /* Período de almacenamiento de mensajes, en días. 0 significa ilimitado. */
      "currencyFormat": <text>, /* Formato de moneda. */
      "services": {             /* Servicios. */
        <text>: {               /* Nombre del servicio. */
          "type": <int>,        /* Tipo de servicio: 1 (bajo demanda), 2 (periódico). */
          "usage": <uint>,      /* Cantidad de elementos utilizados de este servicio. */
          "maxUsage": <int>,    /* Cantidad máxima de elementos de este servicio. */
          "cost": <text>,       /* Tabla de costes. */
          "interval": <int>,    /* Intervalo de reinicio: 0 (ninguno), 1 (cada hora), 2 (diariamente), 3 (semanalmente), 4 (mensualmente). */
          "descr": <text>       /* Descripción. */
        },
        ...
      }
    },
    "personal": {               /* Configuración de la cuenta. */
      ...                       /* En el mismo formato que la configuración del plan de facturación, sin currencyFormat. */
    },
    "combined": {               /* Configuración combinada del plan de facturación y de la cuenta. */
      ...                       /* En el mismo formato que la configuración del plan de facturación, sin currencyFormat. */
    },
    "siteAccess": {             /* Sitios disponibles para la cuenta. */
      <text>: <text>,           /* Clave: nombre del servicio. Valor: nombre DNS o, si el parámetro type contiene 8, detalles del sitio. */
      ...
    },
    "serviceKeys": {            /* Proveedores de mapas externos. */
      <text>: {                 /* Nombre del servicio. */
        "name": <text>,         /* Nombre de la clave del mapa. */
        "type": <int>,          /* Tipo de clave (consulte Tipos de claves de servicio). */
        "provider": <text>      /* Nombre del proveedor de mapas. */
      },
      ...
    }
  },
  "managable": <int>,           /* El usuario actual puede gestionar la cuenta: 0 (no), 1 (sí). */
  "dealerRights": <int>,        /* Derechos de distribuidor para el plan de facturación: 0 (no), 1 (sí). */
  "subPlans": [<text>]          /* Planes de facturación subordinados. */
}

Si la solicitud para varias cuentas se completa con éxito, la respuesta se devuelve en el siguiente formato:

Copied!
{
  <text>: {                     /* ID del elemento solicitado. */
    ...                         /* Información de la cuenta en el formato descrito anteriormente. */
  },
  ...
}

Si un ID del array pertenece a una unidad, un usuario u otro elemento que no es una cuenta, la respuesta contiene los datos de la cuenta a la que pertenece este elemento, bajo el ID solicitado. Si el array contiene varios elementos de la misma cuenta, los datos de la cuenta se devuelven bajo el ID de cada uno de ellos.

La respuesta contiene solo los elementos a los que el usuario tiene el derecho de acceso Ver detalle de propiedades de objeto. Los demás ID se omiten sin error.

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error Descripción
4 Parámetros de entrada incorrectos, o el elemento especificado no es una cuenta. El segundo caso solo se aplica a una solicitud para una cuenta.
7 La cuenta no existe o el usuario no tiene el derecho de acceso Ver detalle de propiedades de objeto a ella. Solo se devuelve en una solicitud para una cuenta.

Detalles de los sitios

Si el parámetro type contiene 2 y 8 (por ejemplo, "type":10), cada valor del objeto siteAccess es un objeto con los detalles del sitio en lugar de un nombre DNS:

Copied!
"siteAccess": {
  <text>: {                           /* Nombre del servicio. */
    "n": <text>,                      /* Nombre DNS. */
    "tt": <text>,                     /* Tipo de plantilla del sitio, por ejemplo, wialon_web, cms_manager, wialon_sdk. */
    "b": <text>,                      /* Rama del sitio. Solo se devuelve si la rama está definida. */
    "sp": <int>,                      /* Puerto SSL. */
    "force_https": <text>,            /* Valor de la propiedad del sitio "force_https". Solo se devuelve si la propiedad está definida. */
    "ignore_in_cms_login_as": <text>  /* Valor de la propiedad del sitio "ignore_in_cms_login_as". Solo se devuelve si la propiedad está definida. */
  },
  ...
}

Tipos de claves de servicio

El campo type del objeto serviceKeys puede tener los siguientes valores:

Tipo Descripción
0x01 Clave protegida (clave de Gurtam).
0x02 Clave de enrutamiento.
0x04 Clave de geocodificación.
0x08 Clave de matriz de distancias.
0x10 Clave de teselas de mapa.

Flags de la cuenta

Los siguientes flags se utilizan en la configuración de la cuenta y del plan de facturación:

Flag Descripción
0x01 Bloquear a los usuarios si el saldo es inferior al umbral de bloqueo.
0x02 Prohibir el uso de servicios de pago si el saldo es inferior al valor indicado en el parámetro denyBalance.
0x04 Permitir servicios desconocidos.
0x20 Disminuir la cantidad de días en el contador de días y bloquear la cuenta cuando la cantidad de días restantes llegue al mínimo.
0x40 Redefinir los flags del plan de facturación.

Lista de servicios

Los siguientes servicios pueden estar disponibles en un plan de facturación:

Servicio Tipo Descripción
avl_resource periódico Activa la sección Cuentas del CMS Manager; define la cantidad y el coste de los recursos y las cuentas.
avl_retranslator periódico Activa la sección Repetidores del CMS Manager y define la cantidad permitida y el coste de los repetidores.
avl_route periódico Activa el módulo Rutas. Habilita la pestaña Rutas y los informes y notificaciones asociados.
avl_unit periódico Activa la sección Unidades del CMS Manager y la pestaña Unidades del sistema de rastreo. Define el coste y la cantidad de unidades.
avl_unit_group periódico Activa la sección Grupos de unidades del CMS Manager y la pestaña Unidades del sistema de rastreo. Define el coste y la cantidad de grupos de unidades.
cms_manager bajo demanda Concede acceso al CMS Manager.
create_units bajo demanda Activa el botón para crear unidades en la sección Unidades del CMS Manager y en la pestaña Unidades del sistema de rastreo.
create_users bajo demanda Activa el botón para crear usuarios en la sección Usuarios del CMS Manager y en la pestaña Usuarios del sistema de rastreo.
create_unit_groups bajo demanda Activa el botón para crear grupos de unidades en la sección Grupos de unidades del CMS Manager y en la pestaña Grupos de unidades del sistema de rastreo.
create_resources bajo demanda Activa el botón para crear recursos y cuentas en la sección Recursos del CMS Manager.
custom_fields periódico Activa la pestaña Campos personalizados en las propiedades de unidades, usuarios o grupos. Define el coste y la cantidad (sumada, por objetos de distintos tipos) de campos personalizados; no afecta a conductores ni remolques.
custom_reports bajo demanda Activa los informes avanzados: informes sobre grupos de unidades, usuarios, conductores, remolques, así como grupos de conductores y remolques (excepto la tabla Historial para usuarios y grupos de unidades). Funciona dentro del módulo Informes.
drivers periódico Activa el módulo Conductores y define el coste y la cantidad de conductores. Si está deshabilitado, no se muestra la pestaña Conductores y las menciones de conductores desaparecen de las notificaciones, los parámetros de usuario y la ventana de SMS.
driver_groups periódico Define la cantidad y el coste de los grupos de conductores. Funciona dentro del módulo Conductores.
email_notification bajo demanda Habilita el envío de notificaciones por email. El límite recomendado es de 10 informes por hora (para evitar la sobrecarga del servidor).
email_report bajo demanda Habilita el envío de informes por email (dentro del módulo Tareas). El límite recomendado es de 10 informes por hora (para evitar la sobrecarga del servidor).
google_service bajo demanda Activa los servicios de Google.
import_export bajo demanda Activa las funciones de Importar/Exportar en los sitios de rastreo.
jobs periódico Activa la pestaña Tareas. Define el coste y la cantidad permitida de tareas.
locator bajo demanda Activa la opción Localizador en el menú de usuario.
messages bajo demanda Concede acceso a la pestaña Mensajes.
net_access (obsoleto) bajo demanda Permite la autenticación mediante el conector de servicios en Wialon Pro.
notifications periódico Activa la pestaña Notificaciones y define el coste y la cantidad permitida de notificaciones.
orders periódico Activa el acceso a la aplicación Logistics y permite ejecutar el informe Pedidos sobre unidades y conductores en el sistema de rastreo.
pois (obsoleto) periódico Activa el panel de puntos de interés (POI) y define el coste y la cantidad permitida de puntos de interés.
reports bajo demanda Activa el módulo Informes y define el coste y la cantidad permitida de plantillas de informes. Si está deshabilitado, desaparecen las tareas y notificaciones asociadas y no se puede utilizar la detección de viajes.
retranslator_units periódico Define la cantidad de unidades disponibles vinculadas a repetidores activados.
rounds periódico Define la cantidad permitida de rutinas y su coste (dentro del módulo Rutas).
route_schedules periódico Define la cantidad permitida de horarios y su coste (dentro del módulo Rutas).
sdk bajo demanda Concede acceso a las aplicaciones.
service_intervals periódico Define el coste y la cantidad de intervalos de servicio. Si está activado, aparece la pestaña Intervalos de servicio en las propiedades de la unidad. Permite registrar eventos del tipo Mantenimiento, ejecutar informes y recibir notificaciones sobre el mantenimiento.
sms bajo demanda Determina la cantidad permitida de mensajes SMS y su coste.
tacho bajo demanda Activa las tablas Actividad del conductor e Infracciones en los informes sobre conductores.
storage_user periódico Activa la pestaña Usuarios y define el coste y la cantidad de usuarios.
trailers periódico Activa la pestaña Remolques y define el coste y la cantidad de remolques.
trailer_groups periódico Define la cantidad y el coste de los remolques; funciona dentro del módulo Remolques.
unit_commands periódico Activa la pestaña Comandos en las propiedades de la unidad. Define la cantidad (para todas las unidades en total) y el coste de los comandos.
unit_sensors periódico Define la cantidad de sensores (calculada para todas las unidades en total) y su coste.
user_notifications periódico Permite recibir mensajes informativos del administrador del servicio.
Wialon_activex (obsoleto) bajo demanda Concede acceso remoto al sistema mediante SDK, ActiveX.
wialon_mobile (obsoleto) bajo demanda Activa el acceso a la aplicación para Android y iOS.
wialon_mobile2 bajo demanda Activa el acceso a la aplicación para Android y iOS. Requiere que el servicio wialon_mobile esté habilitado.
wialon_sdk bajo demanda Concede acceso remoto al sistema mediante SDK.
zones_library periódico Activa el módulo Geocercas y define el coste y la cantidad de geocercas. Si está deshabilitado, no se muestra la pestaña Geocercas y todas las menciones de geocercas desaparecen de los informes y los parámetros de usuario.
zone_groups periódico Activa los grupos de geocercas.
AgroService (obsoleto) Tipo Descripción
agroplots periódico Parcelas
agroplotgroups periódico Grupos de parcelas
agrocrops periódico Cultivos
agromachines periódico Máquinas
agroequipments periódico Equipos
agrocultivationtypes periódico Tipos de cultivo

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.