Skip to content

14. Zonas

Este modulo es el encargado de gestionar las zonas del sistema, se exponen los siguientes recursos:

Una zona puede ser propia o de algún cliente

Método Endpoint Descripción
GET /api/zones Lista de zonas registradas
POST /api/zones Crear una zona
GET /api/zones/{zone} Detalles de zona
PATCH /api/zones/{zone} Modificación de datos de una zona
DELETE /api/zones/{zone} Eliminación de una zona

Ejemplo de cuerpo json POST

{
    "color": "#F39C19",
    "code": "z001",
    "name": "Uncovia",
    "geo_lng": -77.042754,
    "geo_lat": -12.0463731,
    "gmap_zoom": 15,
    "points": [
        {
            "lat": -12.0488731,
            "lng": -77.042754
        },
        {
            "lat": -12.0438731,
            "lng": -77.045254
        },
        {
            "lat": -12.0438731,
            "lng": -77.040254
        }
    ],
    "area_type": "polygon"
}

14.1 Parámetros

Nombre Modo Tipo Descripción
code Optional String Código de Zona
name Required String Nombre de la Zona
color Required String Color en formato hexadecimal
geo_lat Required Numeric Latitud
geo_lng Required Numeric Longitud
points Optional Array Ubicación que abarca varios puntos para formar el poligono (polygon)
points.*.lng Optional Numeric Latitud de punto
points.*.lat Optional Numeric Longitud de punto