Consulta de la zona restringida
Para consultar un área de restricción debe realizar una solicitud GET al siguiente endpoint:
- https://api.maplink.global/restriction/v1/restrictionZones –
GET
Devolverá todas las áreas de restricción creadas; - https://api.maplink.global/restriction/v1/restrictionZones/{{restrictionZone} } – GET
Devolverá sólo el área de restricción especificada. El término{{restrictionZone}}
debe sustituirse por el nombre del área de restricción deseada.
Para consultar el área de restricción creada en el ejemplo anterior, realizaremos una petición GET al endpoint: https://api.maplink.global/restriction/v1/restrictionZones/RestrictionZone1
La respuesta devolverá toda la información relativa al área de restricción deseada. El campo status
indica si el área de restricción está lista para su uso o si se ha producido algún error en su creación, como un polígono incompleto, por ejemplo.
Los valores posibles pueden devolverse en status
:
IN_CALCULATION("Calculating roads inside geometries")
– Esto significa que el área de restricción aún se está procesando y no está disponible para su uso.CALCULATED("Roads inside restriction zone calculated")
– El área de restricción se ha creado correctamente y ya está disponible para su uso.CALCULATED_WITHOUT_ROADS("No road found after calculation inside restriction zone")
– La zona de restricción se ha creado con éxito, pero no hay ninguna carretera que la atraviese.CALCULATION_ERROR("Error trying to calculate restriction zone: [%s]")
– Se ha producido un error en la creación del área de restricción y no está disponible para su uso. El mensaje de error dará más detalles de lo que puede haber ocurrido.
A continuación encontrará la respuesta completa:
{ "name": "RestrictionZone1", "geometries": [ { "name": "Polygon1", "vertices": [ { "latitude": -23.694834, "longitude": -46.777038 }, { "latitude": -23.694834, "longitude": -46.448822 }, { "latitude": -23.472064, "longitude": -46.448822 }, { "latitude": -23.472064, "longitude": -46.777038 } ] } ], "status": { "name": "CALCULATED", "description": "Roads inside restriction zone calculated" } }