7.3. Consultando a área de restrição

Para consultar uma área de restrição você deverá realizar uma requisição do tipo GET para o seguinte endpoint:

https://api.maplink.global/restriction/v1/restrictionZones - GET
Retornará todas as áreas de restrição criadas;
https://api.maplink.global/restriction/v1/restrictionZones/{{restrictionZone}} - GET
Retornará apenas a área de restrição especificada. O termo {{restrictionZone}} deve ser substituído pelo nome da área de restrição desejada.

Para consultar a área de restrição criada no exemplo anterior, faremos uma requisição GET para o endpoint:

https://api.maplink.global/restriction/v1/restrictionZones/RestrictionZone1

Na resposta será retornado todas as informações referentes a área de restrição desejada. O campo status indica se a área de restrição já está pronta para o uso ou se houve algum erro na sua criação, como um polígono incompleto, por exemplo.

Os possíveis valores podem ser retornados em status:

IN_CALCULATION("Calculating roads inside geometries") - Significa que a área de restição ainda está sendo processada e não está disponível para uso.
CALCULATED("Roads inside restriction zone calculated") - A área de restrição foi criada com sucesso e já está disponível para uso.
CALCULATED_WITHOUT_ROADS("No road found after calculation inside restriction zone") - A área de restrição foi criada com sucesso, porém não existe nenhuma via que passe por dentro dela.
CALCULATION_ERROR("Error trying to calculate restriction zone: [%s]") - Houve algum erro no criação da área de restrição e ela não está disponível para uso. A mensagem de erro trará mais detalhes do que pode ter acontecido.

Abaixo a resposta 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"
    }
}