update_zone
Para crear, modificar o eliminar geocercas, utilice el método resource/update_zone.
Endpoint
svc=resource/update_zone¶ms={
"itemId": <long>,
"id": <long>,
"callMode": "<text>",
"n": "<text>",
"d": "<text>",
"t": <uint>,
"w": <uint>,
"f": <uint>,
"c": <uint>,
"tc": <uint>,
"ts": <uint>,
"min": <uint>,
"max": <uint>,
"path": "<text>",
"libId": <long>,
"oldItemId": <long>,
"oldZoneId": <uint>,
"jp": <JSON>,
"p": [
{
"x": <double>,
"y": <double>,
"r": <uint>
}
]
}
Parámetros
Los parámetros itemId, id y callMode son obligatorios para todas las acciones. Para create y update, también son obligatorios los parámetros n, t, w, f, c y p, y los demás parámetros son opcionales. Para delete y reset_image, solo se utilizan itemId, id y callMode.
| Parámetro | Descripción |
|---|---|
itemId |
ID del recurso. |
id |
ID de la geocerca. Para create, el valor no se utiliza, así que indique 0. |
callMode |
Acción: create, update, delete o reset_image (eliminar la imagen o el icono de la geocerca). |
oldItemId |
ID del recurso del que debe copiarse la imagen de la geocerca. Opcional. Se utiliza solo junto con oldZoneId. |
oldZoneId |
ID de la geocerca cuya imagen debe copiarse. Opcional. Se utiliza solo junto con oldItemId. |
n |
Nombre. |
d |
Descripción. Opcional. Si no se indica, la descripción queda vacía. Al actualizar una geocerca, esto elimina su descripción actual. |
t |
Tipo de geocerca:
|
w |
Ancho de línea. Para un círculo, es el radio. El valor se indica en pies si el recurso utiliza el sistema de medida estadounidense o imperial, y en metros en caso contrario. |
f |
Flags (vea Flags de geocerca). |
c |
Color (ARGB). |
tc |
Color del texto (RGB). Opcional. El valor predeterminado es 16711884 (0xFF00CC). |
ts |
Tamaño del texto. Opcional. El valor predeterminado es 12. |
min |
Escala mínima (visibilidad desde). Opcional. El valor predeterminado es 0. |
max |
Escala máxima (visibilidad hasta). Opcional. El valor predeterminado es 4294967295 (0xFFFFFFFF). |
path |
Ruta al icono. Opcional. |
libId |
ID de la biblioteca de iconos. Opcional. El valor predeterminado es 0 (la biblioteca de iconos predeterminada). |
jp |
Campos personalizados en el formato nombre:valor. Opcional. |
p |
Puntos, donde x es la longitud, y es la latitud y r es el radio. Cada punto debe contener los tres valores. Una línea debe tener al menos 2 puntos, un polígono al menos 3 y un círculo exactamente 1. Los puntos con coordenadas no válidas se omiten. Para un círculo, el radio se toma de w y r se ignora. Las unidades de r son las mismas que las de w. |
Al actualizar una geocerca, los parámetros tc, ts, min, max, path, libId y jp que no se indican conservan sus valores actuales. También se conserva la imagen o el icono de la geocerca. Al crear una geocerca, en su lugar se utilizan los valores predeterminados.
Para copiar la imagen de otra geocerca, indique los parámetros
oldItemIdyoldZoneId. Solo se copia la imagen o el icono de la geocerca de origen. Las demás propiedades (por ejemplo, el color del texto o los campos personalizados) se toman de la solicitud, por lo que debe indicarlas explícitamente. El usuario debe tener el derecho de acceso Ver geocercas al recurso de origen.
Para más información sobre las propiedades de las geocercas, consulte resource/get_zone_data.
Flags de geocerca
Están disponibles los siguientes flags de geocerca (f):
| Flag | Descripción |
|---|---|
0x2 |
Geocerca donde comienza una rutina. Se utiliza en los informes si las geocercas de inicio y fin de las rutinas no están indicadas en la configuración de la tabla. |
0x4 |
Geocerca donde termina una rutina. Se utiliza en los informes si las geocercas de inicio y fin de las rutinas no están indicadas en la configuración de la tabla. |
0x10 |
Se establece automáticamente al guardar la geocerca. |
0x20 |
Mostrar forma. |
0x40 |
No simplificar la geocerca. |
El flag 0x10 siempre se agrega al valor guardado. El flag 0x20 también se agrega si la solicitud no contiene ninguno de los parámetros tc, ts, min, max, libId, path y jp. Por ejemplo, si indica "f": 0 sin estos parámetros, la geocerca se guarda con el valor de flags 48 (0x30).
Respuesta
Si una solicitud create, update o reset_image se completa con éxito, la respuesta se devuelve en el siguiente formato:
[
<long>, /* ID de la geocerca */
{
"n": "<text>", /* nombre */
"d": "<text>", /* descripción */
"id": <long>, /* ID de la geocerca */
"f": <uint>, /* flags */
"t": <int>, /* tipo: 1 (línea), 2 (polígono), 3 (círculo) */
"w": <int>, /* ancho de línea o radio del círculo, en pies o metros según el sistema de medida del recurso */
"e": <ushort>, /* suma de comprobación de los datos de la geocerca (CRC16) */
"c": <uint>, /* color (ARGB) */
"i": <uint>, /* suma de comprobación de la imagen (CRC32); 4294967295 si la geocerca no tiene imagen propia */
"icon": "<text>", /* URI de la imagen del icono; se devuelve solo si la geocerca tiene una imagen o un icono de la biblioteca */
"libId": <long>, /* ID de la biblioteca de iconos, 0 para la biblioteca de iconos predeterminada */
"path": "<text>", /* ruta corta al icono de la biblioteca de iconos; vacía si la geocerca no tiene ese icono */
"b": { /* límites */
"min_x": <double>, /* longitud mínima */
"min_y": <double>, /* latitud mínima */
"max_x": <double>, /* longitud máxima */
"max_y": <double>, /* latitud máxima */
"cen_x": <double>, /* longitud del centro */
"cen_y": <double> /* latitud del centro */
},
"ct": <uint>, /* hora de creación */
"mt": <uint>, /* hora de la última modificación */
"jp": <JSON> /* JSON personalizado; se devuelve solo si está especificado para la geocerca */
}
]
La respuesta no contiene los campos tc, ts, min, max y p. Para obtenerlos, utilice resource/get_zone_data.
Para los flags de geocerca, consulte Flags de geocerca.
Si una solicitud delete se completa con éxito, la respuesta se devuelve en el siguiente formato:
[
<long>, /* ID de la geocerca */
null
]
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. Si falta un parámetro obligatorio o tiene un tipo incorrecto, la respuesta también contiene el motivo. Si el valor de callMode, el tipo de geocerca o la cantidad de puntos no son válidos, solo se devuelve el código de error. |
| 6 | La geocerca con el ID indicado no existe en el recurso, o no se pudo eliminar, o no se pudo restablecer su imagen. |
| 7 | El objeto con el ID indicado no existe o no es un recurso, o el usuario no tiene el derecho de acceso Crear, modificar y eliminar geocercas al recurso. Al copiar una imagen, este error también se devuelve si el recurso o la geocerca de origen no existen, o si el usuario no tiene el derecho de acceso Ver geocercas al recurso de origen. |