Delen via


WFS - Get Features

Gebruik om een gedetailleerde lijst met functies van een verzameling op te halen.

De Get Features API is een HTTP-aanvraag GET die een gedetailleerde lijst met functies in de opgegeven verzameling retourneert.

De WFS-API volgt de Open Geospatial Consortium API-standaard voor functies voor het uitvoeren van query's op gegevenssets.

Een gegevensset bestaat uit meerdere functieverzamelingen. Een functieverzameling is een verzameling functies van een vergelijkbaar type, gebaseerd op een gemeenschappelijk schema.

Aanvraag voor get-functies indienen

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

URI-parameters

Name In Vereist Type Description
collectionId
path True

string

Id (naam) van een specifieke verzameling

datasetId
path True

string

De id voor de gegevensset waaruit een query moet worden uitgevoerd.

geography
path True

string

Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.

api-version
query True

string

Versienummer van Azure Maps API.

bbox
query

number[]

Alleen functies met een geometrie die het opgegeven begrenzingsvak kruist, worden geselecteerd.

  • Linkerbenedenhoek, coördinaatas 1 * Linkerbenedenhoek, coördinaatas 2 * Rechterbovenhoek, coördinaatas 1 * Rechterbovenhoek, coördinaatas 2 Het coördinatenreferentiesysteem van de waarden is WGS84 lengtegraad/breedtegraad (http://www.opengis.net/def/crs/OGC/1.3/CRS84), tenzij een ander coördinatenreferentiesysteem is opgegeven in de parameter bbox-crs. Voor WGS84-lengtegraad/breedtegraad zijn de waarden in de meeste gevallen de reeks van minimale lengtegraad, minimum breedtegraad, maximale lengtegraad en maximale breedtegraad. In gevallen waarin het vak echter de antimeridische waarde omspant, is de eerste waarde (west-meest box edge) groter dan de derde waarde (oost-meest box edge).
filter
query

string

Filterexpressie om te zoeken naar functies met specifieke eigenschapswaarden in een bepaalde verzameling. Alleen functie-eigenschappen van het scalaire type en is gelijk aan operator worden ondersteund. Dit is een speciale parameter waarbij de parameternaam een hoofdlettergevoelige eigenschapsnaam is. Het schema voor deze parameter is {property name}={property value}. Tenzij 'filter' een van de eigenschapsnamen in de verzameling is, mag 'filter' niet worden gebruikt als parameternaam. Gebruik 'name=21N13' om te zoeken naar functies met de eigenschap 'naam' waarde '21N13'. Meerdere filters worden ondersteund en moeten worden weergegeven als meerdere queryparameters. Bijvoorbeeld: =&= Tekenreekswaarden zijn hoofdlettergevoelig.

limit
query

integer

De optionele limietparameter beperkt het aantal functies dat wordt weergegeven in het antwoorddocument. Alleen functies die zich op het eerste niveau van de verzameling in het antwoorddocument bevinden, worden meegeteld. Geneste objecten in de expliciet aangevraagde functies worden niet meegeteld.

  • Minimum = 1 * Maximum = 500 * Standaard = 10

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-id

string

Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name Type Description
200 OK

ExtendedGeoJsonFeatureCollection

OK

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

GetFeatures

Voorbeeldaanvraag

GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46

Voorbeeldrespons

{
  "type": "FeatureCollection",
  "ontology": "Facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "navigableBy": [
          "pedestrian"
        ],
        "isRoutable": false,
        "routeThroughBehavior": "allowed",
        "nonPublic": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "addressRoomNumber": "",
        "name": "21N13",
        "nameSubtitle": "",
        "nameAlt": ""
      },
      "id": "UNIT39",
      "featureType": ""
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
      "rel": "self"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "data"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
      "rel": "next"
    }
  ]
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

ExtendedGeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype uitgebreid met numberReturned en koppelingenmatrix. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonObjectType

Hiermee geeft u het GeoJSON type: FeatureCollection.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946 voor meer informatie.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946 voor meer informatie.

WFSEndpointLink

Koppelingen naar andere WFS-eindpunten

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ExtendedGeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype uitgebreid met numberReturned en koppelingenmatrix. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
features

GeoJsonFeature[]

Bevat een lijst met geldige GeoJSON Feature objecten.

links

WFSEndpointLink[]

Koppelingen naar andere WFS-eindpunten.

numberReturned

integer

Aantal geretourneerde functies.

ontology

string

De ontologieversie van deze gegevensset.

type

GeoJsonObjectType

Hiermee geeft u het GeoJSON type: FeatureCollection.

GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
featureType

string

Het type van de functie. De waarde is afhankelijk van het gegevensmodel waarvan de huidige functie deel uitmaakt. Sommige gegevensmodellen hebben mogelijk een lege waarde.

geometry GeoJsonGeometry:

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.

id

string

Id voor de functie.

type string:

Feature

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
type

GeoJsonObjectType

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
geometries GeoJsonGeometry[]:

Bevat een lijst met geldige GeoJSON geometrieobjecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.

type string:

GeometryCollection

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

Coördinaten voor de GeoJson LineString geometrie.

type string:

LineString

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

Coördinaten voor de GeoJson MultiLineString geometrie.

type string:

MultiLineString

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

Coördinaten voor de GeoJson MultiPoint geometrie.

type string:

MultiPoint

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

Bevat een lijst met geldige GeoJSON Polygon objecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.

type string:

MultiPolygon

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonObjectType

Hiermee geeft u het GeoJSON type: FeatureCollection.

Name Type Description
FeatureCollection

string

GeoJSON FeatureCollection Object.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

A Position is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/hoogte is een optioneel derde element. Raadpleeg RFC 7946 voor meer informatie.

type string:

Point

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name Type Description
coordinates

number[]

Coördinaten voor het GeoJson Polygon geometrietype.

type string:

Polygon

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Koppelingen naar andere WFS-eindpunten

Name Type Description
href

string

Het koppelingsdoel.

hreflang

string

Een hint die aangeeft wat de taal van het resultaat van het opnieuw uitstellen van de koppeling moet zijn.

rel

string

Het relatietype.

title

string

Wordt gebruikt om de bestemming van een koppeling zodanig te labelen dat deze kan worden gebruikt als een door mensen leesbare id (bijvoorbeeld een menu-item) in de taal die wordt aangegeven door het veld Content-Language-header (indien aanwezig).

type

string

Een hint die aangeeft wat het mediatype van het resultaat van het opnieuw uitstellen van de koppeling moet zijn.