API: POI
M: Listar geocercas
HTTP GET:
https://<hostname>/api/pois
URL PARAMETERS:
Nombre | Tipo | Requerido | Descripción | |
---|---|---|---|---|
page_size |
Tamaño de Página | Numérico | no | (opcional, default: 5000, max: 5000) Cantidad de elementos que se quiere obtener en la respuesta. |
page_num |
Número de Página | Numérico | no | (opcional, default: 0) Si la cantidad global de elementos es mayor al tamaño de página utilizado, se utiliza este parámetro para obtener una página específica. |
sort_by |
Ordernar por | string | no | Nombre del campo del POI Data Object que se utilizará para ordenar la respuesta. Si el campo es de tipo texto, el orden es alfabético. |
sort_dir |
Dirección de ordenamiento | string | no | Dirección del orden de la respuesta, ascendente (asc) o descendente (desc). |
fields |
Campos | string | no | Nombres de los campos que se quiere obtener del POI Data Object. Deben estar separados por , . |
Este método soporta el uso de filtros.
OUTPUT:
Json con los campos:
success
:boolean
data
:json
Contiene una lista de POI Data Objects.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
-X GET
https://<hostname>/api/pois?page_size=2
RESPUESTA:
{
"success": true,
"data": [
{
"id": "1",
"client_id": "67",
"name": "San Francisco Restaurant",
"use_as_address": "1",
"y": "28.733676131611",
"x": "-110.9776747226",
"corners": "",
"radius": "64",
"geom": "01030000...2BB3C40",
"area": "12868",
"type": "0",
"checkpoint_id": "0",
"created_by": "134",
"custom_map_id": "",
"contact": "",
"url": "",
"is_round": "1",
"creation_date": "2014-12-14 05:36:29+00",
"changed_date": "2015-02-13 14:26:58+00",
"deactivated": "0",
"group_id":"1547",
"custom_fields": {
"owner": "Mario Batali",
"max_capacity": 260
},
"user_ids": null,
"photo_id": null,
"remote_id":"SFRBATALI28110"
},
{
"id": "51",
"client_id": "5",
"name": "Raquel Garcia",
"use_as_address": "1",
"y": "25.8365",
"x": "-97.47022222220",
"corners": "",
"radius": "150",
"geom": "01030000...663940",
"area": "70.6858",
"type": "2",
"checkpoint_id": "0",
"created_by": "",
"custom_map_id": "",
"contact": "",
"url": "",
"is_round": "1",
"creation_date": "2015-02-15 02:16:48+00",
"changed_date": "2016-03-20 22:35:02+00",
"deactivated": "0",
"group_id":"1547",
"custom_fields": null,
"user_ids": null,
"photo_id": null,
"remote_id": null
}
]
}
M: Insertar geocerca
HTTP POST:
https://<hostname>/api/poi
BODY PARAMETERS:
- POI Data Object. Todos los campos requeridos
OUTPUT:
Json con los campos:
success
:boolean
id
:string
id de la geocerca creada.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
-X POST
--data "name=ejemplo&use_as_address=1&radius=15&y=28.7&x=-100.1&type=0&group_id=1546"
https://<hostname>/api/poi
RESPUESTA:
{
"success": true,
"id": "15398"
}
M: Actualizar geocerca
HTTP PUT:
https://<hostname>/api/poi/<id>
BODY PARAMETERS:
- POI Data Object. Sólo los campos que se quiere modificar.
OUTPUT:
Json con los campos:
success
:boolean
data
:json
POI Data Object con los campos modificados.
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
-X PUT
--data "name=ejemplo"
https://<hostname>/api/poi/15398
curl -u <api_key>:<password>
-X PUT
--data 'custom_fields={"Ruta":"Distribución","Telefono":"1234567890","Cantidad en bodega":23}'
https://<hostname>/api/poi/15398
RESPUESTA:
{
"success": true,
"data": {
"id": "15398",
"client_id": "158",
"name": "ejemplo",
"use_as_address": "1",
"y": "28.7",
"x": "-100.1",
"corners": "",
"radius": "15",
"geom": "POLYGON((-100.1 28.7, -100.1 28.7, -100.1 28.7, -100.1 28.7))",
"area": "70685.83470577",
"type": "0",
"checkpoint_id": "0",
"created_by": "703",
"custom_map_id": "",
"contact": "",
"url": "",
"is_round": "1",
"creation_date": "2016-03-14 21:12:43+00",
"changed_date": "2016-03-14 21:12:43+00",
"deactivated": "0",
"group_id":"1547",
"custom_fields": {
"Ruta": "Distribución",
"Telefono": "1234567890",
"Cantidad en bodega": 23
},
"user_ids": "",
"photo_id": "",
"remote_id": ""
}
}
O: POI Data Object
Cada objeto de geocerca tiene estos campos:
Campo | Read-only | Requerido | Tipo de dato | |
---|---|---|---|---|
id |
sí | no | texto | |
client_id |
sí | no | numérico | |
name |
no | sí | texto | |
use_as_address |
no | no | texto | |
x |
no | sí | texto | coordenadas en grados |
y |
no | sí | texto | coordenadas en grados |
corners |
no | no | texto | |
radius |
no | sí | numérico | radio en metros |
geom |
sí | no | texto | |
area |
sí | no | texto | |
type |
no | sí | numérico | siempre enviar "0" |
checkpoint_id |
sí | no | numérico | |
created_by |
sí | no | numérico | |
custom_map_id |
sí | no | numérico | |
contact |
no | no | texto | |
url |
no | no | texto | |
is_round |
sí | no | numérico | |
creation_date |
sí | no | fecha | |
changed_date |
sí | no | fecha | |
deactivated |
no | no | numérico | |
group_id |
no | sí | numérico | id del grupo de geocercas |
custom_fields |
no | no | texto | json de campos personalizados. Debe ser válido según el Custom Fields Schema del Cliente. |
user_ids |
no | no | lista | |
photo_id |
no | no | numérico | |
remote_id |
no | no | texto | identificador editable por el usuario. Debe ser único por Cliente. |