check_unique
Para comprobar si un valor ya está en uso, utilice el método core/check_unique. Puede comprobar los nombres de usuario, los nombres de recursos, los números de teléfono de unidades y conductores, y los ID únicos de los dispositivos de las unidades.
Endpoint
Para comprobar un solo nombre de usuario, nombre de recurso o número de teléfono, utilice la siguiente solicitud:
svc=core/check_unique¶ms={
"type": "<text>",
"value": "<text>"
}
Para comprobar varios valores a la vez o el ID único del dispositivo de una unidad, utilice la siguiente solicitud:
svc=core/check_unique¶ms={
"items": [
{
"type": "<text>",
"value": "<text>"
},
{
"hwType": <long>,
"uniqueId": "<text>"
},
...
]
}
Parámetros
La solicitud debe contener los parámetros type y value, o bien el parámetro items. Si la solicitud contiene ambos, se utilizan los parámetros type y value, y el parámetro items se ignora.
| Parámetro | Descripción |
|---|---|
type |
Tipo de elemento: user, avl_resource o avl-phones (número de teléfono de una unidad o de un conductor). Los nombres de unidades y conductores no tienen que ser únicos, por lo que no se pueden comprobar con este método. Para buscar una unidad o un conductor por nombre, utilice el método core/search_items. |
value |
Valor que se debe comprobar: el nombre de usuario, el nombre de recurso o el número de teléfono. Los nombres distinguen entre mayúsculas y minúsculas: por ejemplo, john_smith y John_Smith son nombres diferentes. Especifique el número de teléfono en formato internacional con el carácter +, por ejemplo, +37011122233. |
items |
Matriz de valores que se deben comprobar. Cada elemento de la matriz debe contener los parámetros type y value, o bien los parámetros hwType y uniqueId. |
hwType |
ID de tipo de dispositivo. Se utiliza solo en los elementos de la matriz items. Puede obtener el ID del campo id en la respuesta del método core/get_hw_types o del campo hw en las propiedades avanzadas de una unidad. |
uniqueId |
ID único del dispositivo de la unidad (por ejemplo, IMEI) especificado en las propiedades de la unidad. Se utiliza solo en los elementos de la matriz items. Puede obtenerlo del campo uid en las propiedades avanzadas de una unidad. La unicidad se comprueba para la combinación del ID único y el tipo de dispositivo: el mismo ID único se puede utilizar con otro tipo de dispositivo. |
Respuesta
Si el valor es único, se devuelve la siguiente respuesta:
{
"result": 0
}
Si el valor ya está en uso, se devuelve la siguiente respuesta:
{
"result": 1
}
Si el parámetro type tiene un valor que no figura en la tabla anterior, se devuelve 0. Lo mismo ocurre con un ID de tipo de dispositivo inexistente.
Si comprueba varios valores, se devuelve una matriz. Cada elemento de la matriz contiene el resultado para el elemento correspondiente de la matriz items: 0 o 1. Por ejemplo:
[0, 1, 0]
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: la solicitud no corresponde a ninguno de los formatos anteriores, o un elemento de la matriz items tiene un formato incorrecto. |
| 1003 | No se pudieron comprobar los límites de solicitudes o se superó el límite de cantidad de solicitudes a la API según una de las reglas. Consulte Restricciones. |
Ejemplos
A continuación se muestran ejemplos de la solicitud core/check_unique.
Comprobación del nombre de usuario
Para comprobar si el nombre de usuario john_smith ya está en uso, especifique user en el parámetro type y el nombre de usuario en el parámetro value. Ambos parámetros son obligatorios.
svc=core/check_unique¶ms={"type":"user","value":"john_smith"}
Respuesta: {"result":1}. El nombre de usuario ya está en uso.
Comprobación del ID único del dispositivo de una unidad
La solicitud comprueba si el ID único 123456789012345 con el ID de tipo de dispositivo 96266 ya está en uso. Un ID único solo se puede comprobar en la matriz items, por lo que la matriz contiene un elemento con los parámetros obligatorios hwType y uniqueId.
svc=core/check_unique¶ms={"items":[{"hwType":96266,"uniqueId":"123456789012345"}]}
No agregue los parámetros type y value a este elemento, ni siquiera con valores vacíos. De lo contrario, se devuelve 0.
Respuesta: [0]. El ID único no está en uso.
Comprobación de varios valores
La solicitud comprueba el nombre de usuario john_smith, el nombre de recurso Delivery Service y el ID único 123456789012345 con el ID de tipo de dispositivo 96266.
svc=core/check_unique¶ms={"items":[{"type":"user","value":"john_smith"},{"type":"avl_resource","value":"Delivery Service"},{"hwType":96266,"uniqueId":"123456789012345"}]}
Respuesta: [1,0,0]. Los resultados siguen el mismo orden que los elementos de la matriz items: el nombre de usuario ya está en uso; el nombre de recurso y el ID único no están en uso.