Spatial

Operations

Get Buffer

Gäller för: prisnivån S1.

Det här API:et returnerar en FeatureCollection där varje funktion är en buffert runt motsvarande indexerade funktion för indata. Bufferten kan vara antingen på utsidan eller inuti den angivna funktionen, beroende på avståndet som anges i indata. Det måste antingen finnas ett avstånd per funktion i FeatureCollection-indata eller, om endast ett avstånd anges, så tillämpas det avståndet på varje funktion i samlingen. Den positiva (eller negativa) bufferten i en geometri definieras som Minkralsumman (eller skillnaden) för geometrin med en cirkel med radie som är lika med det absoluta värdet för buffertavståndet. Buffert-API:et returnerar alltid ett polygonresultat. Den negativa bufferten eller nollavståndsbufferten för linjer och punkter är alltid en tom polygon. Indatafunktionerna tillhandahålls av en GeoJSON-fil som laddas upp via Data Upload API och refereras av ett unikt avvis. GeoJSON-filen kan innehålla en samling Point, MultiPoint, Polygon, MultiPolygon, LineString och MultiLineString. GeometryCollection ignoreras om det anges.

Om du vill testa det här API:et kan du ladda upp exempeldata från exempel på API:et Post Buffer (Request Body without distances array) via Data Upload API och ersätta [udid] från exempelbegäran nedan med det avvisade som returneras av Data Upload-API:et.

Get Closest Point

Gäller för: prisnivån S1.

Det här API:et returnerar den närmaste punkten mellan en baspunkt och en viss uppsättning punkter i den användaruppladdade datauppsättningen som identifierats av udid. Uppsättningen målpunkter tillhandahålls av en GeoJSON-fil som laddas upp via Data Upload API och refereras av ett unikt avvis. GeoJSON-filen får bara innehålla en samling punktgeometri. MultiPoint eller andra geometrier ignoreras om det finns. Det maximala antalet godkända punkter är 100 000. Algoritmen tar inte hänsyn till routning eller trafik. Informationen som returneras innehåller den närmaste punktens latitud, longitud och avståndet i meter från närmaste punkt.

Om du vill testa det här API:et kan du ladda upp exempeldata från Post Closest Point API examples (Request Body) via Data Upload API och ersätta [udid] från exempelbegäran nedan med den udid som returneras av Data Upload-API:et.

Get Geofence

Sök Geofence Get API

Gäller för: S1 Prisnivå.

Med Geofence Get-API:et kan du hämta närhet till en koordinat till ett geofence som har laddats upp till tjänsten Data. Du kan använda Data Upload-API:et för att ladda upp en geofence eller en uppsättning av stängslar. Mer information om geofence-dataformatet finns i Geofencing GeoJSON-data. Om du vill fråga en koordinats närhet anger du platsen för det objekt som du spårar samt ID:t för stängslet eller uppsättningen med stängslar, och svaret innehåller information om avståndet från geofence-områdets yttre kant. Ett negativt värde innebär att koordinaten är innanför stängslet, medan ett positivt värde innebär att den ligger utanför gränsen.

Det här API:et kan användas för en mängd olika scenarier som t.ex. tillgångsspårning, hantering av vagnpark eller att konfigurera aviseringar för att flytta objekt.

API:et stöder integrering med Event Grid. Parametern isAsync används för att aktivera integrering med Event Grid (inaktiverad som standard). Om du vill testa det här API:et kan du ladda upp exempeldata från Post Geofence API-exempel (begärandetext) via Data Upload-API:et och ersätta [udid] från exempelbegäran nedan med det udid som returneras av Data Upload-API:et.

Geofencing InnerError-kod

I geofencing-svarsfelkontraktet innererror är ett objekt som innehåller tjänstspecifik information om felet. code är en egenskap som innererror kan mappa till en specifik geofencingfeltyp. Tabellen nedan visar kodmappningen mellan alla kända klientfeltyper till motsvarande geofencingsfel message .

innererror.code error.message
NullDeviceId Enhets-ID ska inte vara null.
NullUdid Udid ska inte vara null.
UdidWrongFormat Udid ska förvärvas från API:et för inmatning av användardata.
InvalidUserTime Usertime är ogiltigt.
InvalidSearchBuffer Searchbuffer är ogiltigt.
InvalidSearchRange Värdeintervallet för searchbuffer ska vara mellan 0 och 500 meter.
InvalidLatLon Lat- och/eller lonparametrar är ogiltiga.
InvalidIsAsyncValue IsAsync-parametern är ogiltig.
InvalidModeValue Lägesparametern är ogiltig.
InvalidJson Geofencing-data är inte en giltig json-fil.
NotSupportedGeoJson Geofencing-data kan inte läsas som en funktion eller featureCollections.
InvalidGeoJson Geofencing av data är ogiltigt.
NoUserDataWithAccountOrSubscription Det går inte att hitta användargeofencingdata med det angivna konto-ID:t och/eller prenumerations-ID:t.
NoUserDataWithUdid Det går inte att hitta användargeofencingdata med det angivna udId:t.
Get Great Circle Distance

Gäller för: prisnivån S1.

Det här API:et returnerar den stora cirkeln eller det kortaste avståndet mellan två punkter på ytan av en sfär, mätt längs sfärens yta. Detta skiljer sig från att beräkna en rät linje genom sfärens inre. Den här metoden är användbar för att uppskatta resavstånd för flygplan genom att beräkna det kortaste avståndet mellan flygplatserna.

Get Point In Polygon

Gäller för: prisnivån S1.

Det här API:et returnerar ett booleskt värde som anger om en punkt är inuti en uppsättning polygoner. Uppsättningen polygoner tillhandahålls av en GeoJSON-fil som laddas upp via Data Upload API och refereras av ett unikt avvis. GeoJSON-filen kan innehålla Polygon- och MultiPolygon-geometrier. Andra geometrier ignoreras om det finns. Om punkten finns inuti eller vid gränsen för någon av dessa polygoner är det returnerade värdet true. I alla andra fall är det returnerade värdet falskt. När punkten är inuti flera polygoner ger resultatet ett avsnitt med korsande geometrier för att visa alla giltiga geometrier (refereras till av geometryId) i användardata. Det maximala antalet hörn som godkänns för att skapa en Polygon är 10 000.

Om du vill testa det här API:et kan du ladda upp exempeldata från Post Point In Polygon API-exempel (begärandetext) via Data Upload-API:et och ersätta [udid] från exempelbegäran nedan med det udid som returneras av Data Upload-API:et.

Post Buffer

Gäller för: prisnivån S1.

Det här API:et returnerar en FeatureCollection där varje funktion är en buffert runt motsvarande indexerade funktion för indata. Bufferten kan vara antingen på utsidan eller inuti den angivna funktionen, beroende på avståndet som anges i indata. Det måste antingen finnas ett avstånd per funktion i FeatureCollection-indata eller, om endast ett avstånd anges, så tillämpas det avståndet på varje funktion i samlingen. Den positiva (eller negativa) bufferten i en geometri definieras som Minkralsumman (eller skillnaden) för geometrin med en cirkel med radie som är lika med det absoluta värdet för buffertavståndet. Buffert-API:et returnerar alltid ett polygonresultat. Den negativa bufferten eller nollavståndsbufferten för linjer och punkter är alltid en tom polygon. Indata kan innehålla en samling Point, MultiPoint, Polygon, MultiPolygon, LineString och MultiLineString. GeometryCollection ignoreras om det anges.

Post Closest Point

Gäller för: prisnivån S1.

Det här API:et returnerar den närmaste punkten mellan en baspunkt och en viss uppsättning målpunkter. Uppsättningen målpunkter tillhandahålls av användardata i brödtexten efter begäran. Användardata får bara innehålla en samling punktgeometri. MultiPoint eller andra geometrier ignoreras om det finns. Algoritmen tar inte hänsyn till routning eller trafik. Det maximala antalet godkända punkter är 100 000. Informationen som returneras innehåller den närmaste punktens latitud, longitud och avståndet i meter från närmaste punkt.

Post Geofence

Sök Efter API för Geofence Gäller för: S1 Prisnivå. Med Geofence Post-API:et kan du hämta närhet till en koordinat till ett anslaget geofence eller en uppsättning av stängslar. Med POST-anrop behöver du inte ladda upp stängseldata i förväg. I stället anger du platsen för det objekt som du spårar i frågeparametrar samt stängslet eller uppsättningen med stängseldata i efter begärandetexten. Mer information om geofence-dataformatet finns i Geofencing GeoJSON-data. Svaret innehåller information om avståndet från geofence-geofenceens yttre kant. Ett negativt värde innebär att koordinaten är innanför stängslet, medan ett positivt värde innebär att den ligger utanför gränsen.

Det här API:et kan användas för en mängd olika scenarier som t.ex. tillgångsspårning, hantering av vagnpark eller att konfigurera aviseringar för att flytta objekt.

API:et stöder integrering med Event Grid. Parametern isAsync används för att aktivera integrering med Event Grid (inaktiverad som standard).

Post Point In Polygon

Gäller för: prisnivån S1.

Det här API:et returnerar ett booleskt värde som anger om en punkt är inuti en uppsättning polygoner. Användardata kan innehålla Polygon- och MultiPolygon-geometrier. Andra geometrier ignoreras om de tillhandahålls. Om punkten finns inuti eller vid gränsen för någon av dessa polygoner är det returnerade värdet true. I alla andra fall är det returnerade värdet falskt. När punkten är inuti flera polygoner ger resultatet ett avsnitt med korsande geometrier för att visa alla giltiga geometrier (refereras till av geometryId) i användardata. Det maximala antalet hörn som godkänns för att skapa en Polygon är 10 000.