WFS - Get Collections

Reference

Service:: Maps Creator

API Version:: 2.0

Use to get descriptions of all collections in a dataset.

The Get Collections API is an HTTP GET request that provides descriptions of all the collections in the specified dataset.

The WFS API follows the Open Geospatial Consortium API standard for Features to query Datasets.

A dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.

The Collections Description API provides descriptions of all the collections in a given dataset. For more information, see Web Feature service API

Submit Get Collections Request

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections?api-version=2.0

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The identifier for the dataset to query from.
geography	path	True	string	This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.
api-version	query	True	string	Version number of Azure Maps API.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name	Type	Description
200 OK	CollectionsResponse	Ok
Other Status Codes	ErrorResponse	An unexpected error occurred.

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

For more information on Microsoft identity platform, see Microsoft identity platform overview.

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

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

GetCollections

Sample Request

HTTP

GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0

Sample Response

Status code:: 200

{
  "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"
    }
  ]
}

Definitions

Name	Description
Collection
CollectionsResponse
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
WFSEndpointLink	Links to other WFS endpoints

Collection

Name	Type	Description
description	string	a description of the features in the collection
links	WFSEndpointLink[]	Links to other WFS endpoints.
name	string	identifier of the collection used, for example, in URIs
ontology	string	The ontology version of this dataset.
title	string	human readable title of the collection

CollectionsResponse

Name	Type	Description
collections	Collection[]	All the collections in a given dataset.
links	WFSEndpointLink[]	Links to other WFS endpoints.
ontology	string	The ontology version of this dataset.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

WFSEndpointLink

Links to other WFS endpoints

Name	Type	Description
href	string	The link target.
hreflang	string	A hint indicating what the language of the result of dereferencing the link should be.
rel	string	The relation type.
title	string	Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).
type	string	A hint indicating what the media type of the result of dereferencing the link should be.