Spatial

Operations

Get Buffer

Se aplica a: plan de tarifa S1.

Esta API devuelve featurecollection donde cada característica es un búfer alrededor de la característica indizada correspondiente de la entrada. El búfer podría estar en el exterior o dentro de la característica proporcionada, dependiendo de la distancia proporcionada en la entrada. Debe haber una distancia proporcionada por característica en la entrada FeatureCollection o, si solo se proporciona una distancia, esa distancia se aplica a cada característica de la colección. El búfer positivo (o negativo) de una geometría se define como la suma (o diferencia) de Minkski de la geometría con un círculo de radio igual al valor absoluto de la distancia del búfer. La API de búfer siempre devuelve un resultado poligonal. El búfer negativo o de distancia cero de líneas y puntos siempre es un polígono vacío. Las características de entrada se proporcionan mediante un archivo GeoJSON que se carga a través de Data Upload API y al que hace referencia un udid único. El archivo GeoJSON puede contener una colección de Point, MultiPoint, Polygon, MultiPolygon, LineString y MultiLineString. GeometryCollection se omitirá si se proporciona.

Para probar esta API, puede cargar los datos de ejemplo de los ejemplos de API de búfer posterior (matriz Cuerpo de la solicitud sin distancias) a través de data Upload API y reemplazar el [udid] de la solicitud de ejemplo siguiente por el udid devuelto por Data Upload API.

Get Closest Point

Se aplica a: plan de tarifa S1.

Esta API devuelve el punto más cercano entre un punto base y un conjunto determinado de puntos en el conjunto de datos cargado por el usuario identificado por udid. El conjunto de puntos de destino lo proporciona un archivo GeoJSON que se carga a través de Data Upload API y al que hace referencia un udid único. El archivo GeoJSON solo puede contener una colección de geometría point. MultiPoint u otras geometrías se omitirán si se proporcionan. El número máximo de puntos aceptados es 100 000. El algoritmo no tiene en cuenta el enrutamiento ni el tráfico. La información devuelta incluye la latitud, longitud y distancia del punto más cercano en metros desde el punto más cercano.

Para probar esta API, puede cargar los datos de ejemplo de los ejemplos posteriores a la API de punto más cercano (cuerpo de la solicitud) a través de data Upload API y reemplazar el [udid] de la solicitud de ejemplo siguiente por el udid devuelto por Data Upload API.

Get Geofence

Search Geofence Get API

Se aplica a: Plan de tarifa S1.

Geofence Get API permite recuperar la proximidad de una coordenada a una geovalla que se ha cargado en el servicio Data. Puede usar data Upload API para cargar una geovalla o un conjunto de barreras. Consulte Geofencing GeoJSON data (GeoJSON de geovalla) para obtener más información sobre el formato de datos de geovalla. Para consultar la proximidad de una coordenada, proporcione la ubicación del objeto de seguimiento, así como el identificador de la barrera o el conjunto de barreras, y la respuesta contendrá información sobre la distancia desde el borde exterior de la geovalla. Un valor negativo significa que la coordenada está dentro de la barrera, mientras que un valor positivo significa que está fuera de la barrera.

Esta API se puede usar para diversos escenarios que incluyen aspectos como el seguimiento de recursos, la administración de flotas o la configuración de alertas para mover objetos.

La API admite la integración con Event Grid. El parámetro isAsync se usa para habilitar la integración con Event Grid (deshabilitado de forma predeterminada). Para probar esta API, puede cargar los datos de ejemplo de post geofence API examples(Request Body) a través de Data Upload API y reemplazar el [udid] de la solicitud de ejemplo siguiente por el udid devuelto por Data Upload API.

Geovalla de código InnerError

En el contrato de error de respuesta de geovalla, innererror es un objeto que contiene información específica del servicio sobre el error. code es una propiedad en innererror la que se puede asignar a un tipo de error de geovalla específico. En la tabla siguiente se muestra la asignación de código entre todo el tipo de error de cliente conocido al error de geovalla message correspondiente.

innererror.code error.message
NullDeviceId El id. de dispositivo no debe ser NULL.
NullUdid Udid no debe ser NULL.
UdidWrongFormat Udid debe adquirirse de la API de ingesta de datos de usuario.
InvalidUserTime Usertime no es válido.
InvalidSearchBuffer Searchbuffer no es válido.
InvalidSearchRange El intervalo de valores del búfer de búsqueda debe estar entre 0 y 500 metros.
InvalidLatLon Los parámetros lat o lon no son válidos.
InvalidIsAsyncValue El parámetro IsAsync no es válido.
InvalidModeValue El parámetro mode no es válido.
InvalidJson Los datos de geovalla no son un archivo JSON válido.
NotSupportedGeoJson Los datos de geovalla no se pueden leer como Feature o FeatureCollections.
InvalidGeoJson Los datos de geovalla no son válidos.
NoUserDataWithAccountOrSubscription No se pueden encontrar datos de geovalla de usuario con el id. de cuenta o el id. de suscripción proporcionados.
NoUserDataWithUdid No se pueden encontrar datos de geovalla de usuario con el udId proporcionado.
Get Great Circle Distance

Se aplica a: plan de tarifa S1.

Esta API devolverá la distancia de círculo grande o más corta entre dos puntos de la superficie de una esfera, medida a lo largo de la superficie de la esfera. Esto difiere del cálculo de una línea recta a través del interior de la esfera. Este método es útil para calcular las distancias de viaje de los aviones calculando la distancia más corta entre los aeropuertos.

Get Point In Polygon

Se aplica a: plan de tarifa S1.

Esta API devuelve un valor booleano que indica si un punto está dentro de un conjunto de polígonos. El conjunto de polígonos lo proporciona un archivo GeoJSON que se carga a través de Data Upload API y al que hace referencia un udid único. El archivo GeoJSON puede contener geometrías Polygon y MultiPolygon; otras geometrías se omitirán si se proporcionan. Si el punto está dentro o en el límite de uno de estos polígonos, el valor devuelto es true. En todos los demás casos, el valor devuelto es false. Cuando el punto está dentro de varios polígonos, el resultado dará una sección de geometrías intersección para mostrar todas las geometrías válidas (a las que hace referencia geometryId) en los datos del usuario. El número máximo de vértices aceptados para formar un polígono es 10 000.

Para probar esta API, puede cargar los datos de ejemplo de post point in polygon API examples (Request Body) via Data Upload API y reemplazar el [udid] de la solicitud de ejemplo siguiente por el udid devuelto por Data Upload API.

Post Buffer

Se aplica a: plan de tarifa S1.

Esta API devuelve featurecollection donde cada característica es un búfer alrededor de la característica indizada correspondiente de la entrada. El búfer podría estar en el exterior o dentro de la característica proporcionada, dependiendo de la distancia proporcionada en la entrada. Debe haber una distancia proporcionada por característica en la entrada FeatureCollection o, si solo se proporciona una distancia, esa distancia se aplica a cada característica de la colección. El búfer positivo (o negativo) de una geometría se define como la suma (o diferencia) de Minkski de la geometría con un círculo de radio igual al valor absoluto de la distancia del búfer. La API de búfer siempre devuelve un resultado poligonal. El búfer negativo o de distancia cero de líneas y puntos siempre es un polígono vacío. La entrada puede contener una colección de Point, MultiPoint, Polygon, MultiPolygon, LineString y MultiLineString. GeometryCollection se omitirá si se proporciona.

Post Closest Point

Se aplica a: plan de tarifa S1.

Esta API devuelve el punto más cercano entre un punto base y un conjunto determinado de puntos de destino. Los datos del usuario proporcionan el conjunto de puntos de destino en el cuerpo de la solicitud posterior. Los datos de usuario solo pueden contener una colección de geometría point. MultiPoint u otras geometrías se omitirán si se proporcionan. El algoritmo no tiene en cuenta el enrutamiento ni el tráfico. El número máximo de puntos aceptados es 100 000. La información devuelta incluye la latitud, longitud y distancia del punto más cercano en metros desde el punto más cercano.

Post Geofence

Search Geofence Post API Se aplica a: Plan de tarifa S1. Geofence Post API permite recuperar la proximidad de una coordenada a una geovalla proporcionada o un conjunto de barreras. Con la llamada POST, no tiene que cargar los datos de barrera de antemano, sino que proporciona la ubicación del objeto que está siguiendo en los parámetros de consulta, así como la barrera o el conjunto de datos de barreras en el cuerpo de la solicitud posterior. Consulte GeojSON data (GeoJSON de geovalla) para obtener más detalles sobre el formato de datos de geovalla. La respuesta contendrá información sobre la distancia desde el borde exterior de la geovalla. Un valor negativo significa que la coordenada está dentro de la barrera, mientras que un valor positivo significa que está fuera de la barrera.

Esta API se puede usar para una variedad de escenarios que incluyen aspectos como el seguimiento de recursos, la administración de flotas o la configuración de alertas para mover objetos.

La API admite la integración con Event Grid. El parámetro isAsync se usa para habilitar la integración con Event Grid (deshabilitado de forma predeterminada).

Post Point In Polygon

Se aplica a: plan de tarifa S1.

Esta API devuelve un valor booleano que indica si un punto está dentro de un conjunto de polígonos. Los datos de usuario pueden contener geometrías Polygon y MultiPolygon; si se proporcionan, se omitirán otras geometrías. Si el punto está dentro o en el límite de uno de estos polígonos, el valor devuelto es true. En todos los demás casos, el valor devuelto es false. Cuando el punto está dentro de varios polígonos, el resultado dará una sección de geometrías intersección para mostrar todas las geometrías válidas (a las que hace referencia geometryId) en los datos del usuario. El número máximo de vértices aceptados para formar un polygon es 10 000.