WFS - Get Collections
Gebruik deze functie om beschrijvingen van alle verzamelingen in een gegevensset op te halen.
Notitie
Buitengebruikstelling van Azure Maps Creator
De indoor kaartservice van Azure Maps Creator is nu afgeschaft en wordt buiten gebruik gesteld op 30-9-25. Zie einde levensduuraankondiging van Azure Maps Creator voor meer informatie.
De Get Collections
-API is een HTTP-GET
-aanvraag die beschrijvingen biedt van alle verzamelingen in de opgegeven gegevensset.
De WFS-API volgt de Open Georuimtelijke Consortium-API-standaard voor functies om een query uit te voeren op Gegevenssets.
Een gegevensset bestaat uit meerdere functieverzamelingen. Een functieverzameling is een verzameling functies van een vergelijkbaar type, op basis van een gemeenschappelijk schema.
De BESCHRIJVINGs-API voor verzamelingen bevat beschrijvingen van alle verzamelingen in een bepaalde gegevensset. Zie webfunctieservice-API voor meer informatie
Aanvraag ophalen verzamelingen verzenden
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections?api-version=2.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
De id van de gegevensset waaruit een query moet worden uitgevoerd. |
geography
|
path | True |
string |
Deze parameter geeft aan waar de Azure Maps Creator-resource zich bevindt. Geldige waarden zijn ons en eu. |
api-version
|
query | True |
string |
Versienummer van Azure Maps-API. |
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 Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan 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 aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. 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.
Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.
Opmerkingen
- 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 uit de Maps Management API-.
De Authorization URL
is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
* Het op rollen gebaseerde 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 configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.
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 maken in 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 worden uitgegeven.
Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering 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 wordt gemaakt op basis van de bewerking List SAS 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 voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
GetCollections
Voorbeeldaanvraag
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0
Voorbeeldrespons
{
"ontology": "Facility-2.0",
"collections": [
{
"name": "unit",
"description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for unit"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0",
"rel": "data",
"title": "unit"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for unit"
}
]
},
{
"name": "zone",
"description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for zone"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0",
"rel": "data",
"title": "zone"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for zone"
}
]
},
{
"name": "level",
"description": "An indication of the extent and vertical position of a set of features.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for level"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0",
"rel": "data",
"title": "level"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for level"
}
]
},
{
"name": "facility",
"description": "Area of the site, building footprint etc.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for facility"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0",
"rel": "data",
"title": "facility"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for facility"
}
]
},
{
"name": "verticalPenetration",
"description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for verticalPenetration"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0",
"rel": "data",
"title": "verticalPenetration"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for verticalPenetration"
}
]
},
{
"name": "opening",
"description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for opening"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0",
"rel": "data",
"title": "opening"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for opening"
}
]
},
{
"name": "directoryInfo",
"description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for directoryInfo"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0",
"rel": "data",
"title": "directoryInfo"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for directoryInfo"
}
]
},
{
"name": "pointElement",
"description": "A point feature in a unit, such as a first aid kit or a sprinkler head.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for pointElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0",
"rel": "data",
"title": "pointElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for pointElement"
}
]
},
{
"name": "lineElement",
"description": "A line feature in a unit, such as a dividing wall, window.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for lineElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0",
"rel": "data",
"title": "lineElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for lineElement"
}
]
},
{
"name": "areaElement",
"description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for areaElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0",
"rel": "data",
"title": "areaElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for areaElement"
}
]
},
{
"name": "category",
"description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for category"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0",
"rel": "data",
"title": "category"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for category"
}
]
}
],
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0",
"rel": "self"
}
]
}
Definities
Name | Description |
---|---|
Collection | |
Collections |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
WFSEndpoint |
Koppelingen naar andere WFS-eindpunten |
Collection
Name | Type | Description |
---|---|---|
description |
string |
een beschrijving van de functies in de verzameling |
links |
Koppelingen naar andere WFS-eindpunten. |
|
name |
string |
id van de verzameling die wordt gebruikt, bijvoorbeeld in URI's |
ontology |
string |
De ontologieversie van deze gegevensset. |
title |
string |
leesbare titel van de verzameling |
CollectionsResponse
Name | Type | Description |
---|---|---|
collections |
Alle verzamelingen in een bepaalde gegevensset. |
|
links |
Koppelingen naar andere WFS-eindpunten. |
|
ontology |
string |
De ontologieversie van deze gegevensset. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
WFSEndpointLink
Koppelingen naar andere WFS-eindpunten
Name | Type | Description |
---|---|---|
href |
string |
Het koppelingsdoel. |
hreflang |
string |
Een hint die aangeeft wat de taal is van het resultaat van het uitstellen van de koppeling. |
rel |
string |
Het relatietype. |
title |
string |
Wordt gebruikt om de bestemming van een koppeling te labelen, zodat deze kan worden gebruikt als een door mensen leesbare id (bijvoorbeeld een menu-item) in de taal die wordt aangegeven door het veld Inhoudstaal (indien aanwezig). |
type |
string |
Een hint die aangeeft wat het mediatype is van het resultaat van het uitstellen van de koppeling. |