Spatial - Get Geofence

Referens

Service:: Maps

API Version:: 2022-08-01

Använd för att hämta närhet till en koordinat till en geofence.

API:et Get Geofence är en HTTP-begäran GET som hämtar närheten till en koordinat till en geofence som har laddats upp till dataregistret. Du laddar upp en geofence eller en uppsättning staket till ett Azure Storage-konto och registrerar det sedan med ditt Azure Maps-konto med hjälp av dataregistret. Mer information finns i Så här skapar du dataregister. Mer information om geofence-dataformatet finns i Geofencing GeoJSON-data. Om du vill fråga närhet till en koordinat anger du platsen för det objekt som du spårar samt ID:t för staketet eller uppsättningen av staket, och svaret innehåller information om avståndet från den yttre kanten av geofence. Ett negativt värde betyder att koordinaten är inuti stängslet medan ett positivt värde innebär att den ligger utanför stängslet.

Det här API:et kan användas för en mängd olika scenarier som till exempel tillgångsspårning, hantering av vagnpark eller konfiguration av 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 (inaktiverat som standard). Om du vill testa det här API:et kan du ladda upp exempeldata från Post Geofence API-exempel (Begärandetext) med hjälp av dataregistertjänsten och ersätta {udid} från exempelbegäran nedan med den udid som används för att skapa dataregistret. Mer information om dataregistertjänsten finns i Så här skapar du dataregister.

Geofencing InnerError-kod

I kontraktet innererror för geofencing-svarsfel är ett objekt som innehåller tjänstspecifik information om felet. code är en egenskap innererror som kan mappas till en specifik typ av geofencing-fel. Tabellen nedan visar kodmappningen mellan alla kända klientfeltyper till motsvarande geofencing-fel message.

innererror.code	error.message
NullDeviceId	Enhets-ID får inte vara null.
NullUdid	Udid får inte vara null.
UdidWrongFormat	Udid ska hämtas 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	Parametrarna lat och/eller lon är ogiltiga.
InvalidIsAsyncValue	IsAsync-parametern är ogiltig.
InvalidModeValue	Ogiltig lägesparameter.
InvalidJson	Geofencing-data är inte en giltig json-fil.
NotSupportedGeoJson	Geofencing-data kan inte läsas som en funktion eller FeatureCollections.
InvalidGeoJson	Geofencing-data är ogiltiga.
NoUserDataWithAccountOrSubscription	Det går inte att hitta användarens geofencing-data med angivet konto-ID och/eller prenumerations-ID.
NoUserDataWithUdid	Det går inte att hitta användarens geofencing-data med angivet udid.

GET https://{geography}.atlas.microsoft.com/spatial/geofence/json?api-version=2022-08-01&deviceId={deviceId}&udid={udid}&lat={lat}&lon={lon}

With optional parameters:

GET https://{geography}.atlas.microsoft.com/spatial/geofence/json?api-version=2022-08-01&deviceId={deviceId}&udid={udid}&lat={lat}&lon={lon}&z={z}&userTime={userTime}&searchBuffer={searchBuffer}&isAsync={isAsync}&mode={mode}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
geography	path	True	string	Platsen för Azure Maps-kontot. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). Den här parametern krävs när en `udid` anges i begäran. Om till exempel Azure Maps-kontot finns i USA, östra godkänns endast begäranden till oss geografi.
api-version	query	True	string	Versionsnummer för Azure Maps API.
deviceId	query	True	string	Enhetens ID
lat	query	True	number	Latitud för den plats som skickas. Exempel: 48.36.
lon	query	True	number	Longitud för den plats som skickas. Exempel: -124.63.
udid	query	True	string	Det unika ID som används när du skapar ett dataregister för att ladda upp ett giltigt GeoJSON FeatureCollection-objekt. Mer information finns i RFC 7946 . Alla egenskaper för funktionen ska innehålla `geometryId`, som används för att identifiera geometrin och är skiftlägeskänslig. Mer information om dataregistertjänsten finns i Så här skapar du dataregister.
isAsync	query		boolean	Om det är sant använder begäran en asynkron händelsemekanism. om det är falskt synkroniseras begäran och utlöser inte någon händelse. Standardvärdet är false.
mode	query		GeofenceMode	Läge för mekanismen för geofencing-asynkron händelse.
searchBuffer	query		number	Radien för bufferten runt geofence i meter som definierar hur långt man ska söka inom och utanför stängslets kant mot koordinaten som angavs vid beräkningen av resultatet. Det minsta värdet är 0 och det högsta värdet är 500. Standardvärdet är 50.
userTime	query		string date-time	Tid för användarbegäran. Om det inte visas i begäran är standardvärdet DateTime.Now.
z	query		number	Havsnivån i mätaren på den plats som passerar. Om den här parametern visas används 2D-extrusion. Exempel: 200.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	Geofence	OK Huvudvärdet X-Correlation-id finns i ett asynkront anrops svar och Event Grid-händelsedata. Det hjälper till att korrelera asynkront anropets svar med motsvarande Event Grid-händelse. Headers X-Correlation-id: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Name

Typ

Description

200 OK

Geofence

OK Huvudvärdet X-Correlation-id finns i ett asynkront anrops svar och Event Grid-händelsedata. Det hjälper till att korrelera asynkront anropets svar med motsvarande Event Grid-händelse.

Headers

X-Correlation-id: string

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du skapar en Azure Maps resurs via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Type: apiKey
In: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

GetGeofence

Sample Request

HTTP

GET https://us.atlas.microsoft.com/spatial/geofence/json?api-version=2022-08-01&deviceId=unique_device_name_under_account&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=48.36&lon=-124.63&userTime=2022-08-21T17:32:28Z&searchBuffer=50&isAsync=True&mode=EnterAndExit

Sample Response

Status code:: 200

{
  "geometries": [
    {
      "deviceId": "unique_device_name_under_account",
      "udId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "geometryId": "2",
      "distance": 999,
      "nearestLat": 47.621954,
      "nearestLon": -122.131841
    },
    {
      "deviceId": "unique_device_name_under_account",
      "udId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "geometryId": "1",
      "distance": -999,
      "nearestLat": 47.609833,
      "nearestLon": -122.148274
    }
  ],
  "expiredGeofenceGeometryId": [
    "5"
  ],
  "invalidPeriodGeofenceGeometryId": [
    "3",
    "4"
  ],
  "isEventPublished": true
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
Geofence	Det här objektet returneras från ett geofence-närhetsanrop.
GeofenceGeometry	Geofencinggeometrin.
GeofenceMode	Läge för mekanismen för geofencing-asynkron händelse.
JsonFormat	Önskat format för svaret. Endast `json` format stöds.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Geofence

Det här objektet returneras från ett geofence-närhetsanrop.

Name	Typ	Description
expiredGeofenceGeometryId	string[]	Listor av geometri-ID:t för geofence som har upphört att gälla i förhållande till användarens tid i begäran.
geometries	GeofenceGeometry[]	Listor de stängselgeometrier som innehåller koordinatpositionen eller överlappar searchBuffer runt positionen.
invalidPeriodGeofenceGeometryId	string[]	Listor av geometri-ID:t för geofence som är i en ogiltig period i förhållande till användartiden i begäran.
isEventPublished	boolean	Sant om minst en händelse publiceras till Azure Maps händelseprenumerant, falskt om ingen händelse publiceras till Azure Maps händelseprenumerant. Detta visas bara som svar när frågeparametern isAsync är inställd på true.

GeofenceGeometry

Geofencinggeometrin.

Name	Typ	Description
deviceId	string	Enhetens ID.
distance	number	Avstånd från koordinaten till geofencens närmaste kantlinje (i meter utom när särskilda värden -999/999 används). Positivt innebär att koordinaten ligger utanför geofence-området. Om koordinaten ligger utanför geofence-värdet, men mer än värdet för searchBuffer bort från närmaste geofence-kantlinje, är värdet 999. Negativt innebär att koordinaten är inuti geofencen. Om koordinaten finns inuti polygonen, men mer än värdet för searchBuffer bort från närmaste geofencing-kantlinje, är värdet -999. Värdet 999 innebär att koordinaten är mycket säker på att den ligger långt utanför geofence-området. Värdet -999 innebär att koordinaten är mycket säker på att den ligger väl inom geofence-området.
geometryId	string	Det unika ID:t identifierar en geometri.
nearestLat	number	Latitud för den närmaste punkten i geometrin.
nearestLon	number	Longitud för den närmaste punkten i geometrin.
nearestZ	number	Havsnivå i mätare för närmaste punkt på 2D-extruderingsgeometrin. Detta visas endast som svar när värdet anges för "zInMeter" i begäran.
udId	string	Det unika ID som används när du skapar ett dataregister för att ladda upp ett giltigt GeoJSON FeatureCollection-objekt. Mer information finns i RFC 7946 . Alla egenskaper för funktionen ska innehålla `geometryId`, som används för att identifiera geometrin och är skiftlägeskänslig. Mer information om dataregistertjänsten finns i Så här skapar du dataregister.

GeofenceMode

Läge för mekanismen för geofencing-asynkron händelse.

Name	Typ	Description
All	string	Publicera alla frågeresultat till Azure Maps kontohändelseprenumeration.
EnterAndExit	string	Publicera endast resultat när användarens plats anses korsa geofencing boarder.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

Share via

Spatial - Get Geofence

Geofencing InnerError-kod

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Kommentarer

Scopes

subscription-key

SAS Token

Exempel

GetGeofence

Sample Request

Sample Response

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Geofence

GeofenceGeometry

GeofenceMode

JsonFormat

Ytterligare resurser