Поделиться через

WFS - Get Features

  • Ссылка
Служба:
Maps Creator
Версия API:
2.0

Используйте для получения подробного списка функций коллекции.

API Get Features — это HTTP-запрос GET , возвращающий подробный список компонентов указанной коллекции.

API WFS соответствует стандарту API Открытого геопространственного консорциума для функций для запроса наборов данных.

Набор данных состоит из нескольких коллекций компонентов. Коллекция признаков — это коллекция признаков аналогичного типа, основанная на общей схеме.

Отправка запроса на получение функций

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

Имя В Обязательно Тип Описание
collectionId
 path True

string

Идентификатор (имя) определенной коллекции
datasetId
 path True

string

Идентификатор набора данных для запроса.
geography
 path True

string

Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
api-version
 query True

string

Номер версии API Azure Maps
bbox
 query

number[]

Выбираются только те объекты, которые имеют геометрию, пересекающую предоставленный ограничивающий прямоугольник.

  • Нижний левый угол, ось координат 1 * Нижний левый угол, ось координат 2 * Верхний правый угол, ось координат 1 * Верхний правый угол, ось координат 2. Система координатных ссылок значений — WGS84 долгота/широта (http://www.opengis.net/def/crs/OGC/1.3/CRS84), если в параметре bbox-crsне указана другая система координат. Для WGS84 долгота/широта значениями в большинстве случаев являются последовательность минимальной долготы, минимальной широты, максимальной долготы и максимальной широты. Однако в тех случаях, когда поле охватывает antimeridian, первое значение (западная граница прямоугольника) больше третьего значения (восточная граница прямоугольника).
filter
 query

string

Выражение фильтра для поиска признаков с определенными значениями свойств в данной коллекции. Поддерживаются только свойства признаков скалярного типа и оператора equals. Это специальный параметр, в котором имя параметра является именем свойства с учетом регистра. Схема для этого параметра — {имя свойства}={значение свойства}. Если "filter" не является одним из имен свойств в коллекции, "filter" не следует использовать в качестве имени параметра. Для поиска признаков со значением свойства "name" "21N13" используйте "name=21N13". Поддерживаются несколько фильтров, которые должны быть представлены в виде нескольких параметров запроса. Например, =&= Строковые значения чувствительны к регистру.
limit
 query

integer

Необязательный параметр limit ограничивает количество функций, представленных в документе ответа. Учитываются только компоненты, которые находятся на первом уровне коллекции в документе ответа. Вложенные объекты, содержащиеся в явно запрошенных признаках, не учитываются.

  • Минимум = 1 * Максимум = 500 * По умолчанию = 10

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя Тип Описание
200 OK

ExtendedGeoJsonFeatureCollection

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы обеспечить безопасное хранение ключа.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса, созданный с помощью операции List SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов, используемых для конкретного маркера. Другими словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

GetFeatures

Образец запроса

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

Пример ответа

Код состояния:
200 
{
  "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"
    }
  ]
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
ExtendedGeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта, расширенный массивом numberReturned и links. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonFeature

Допустимый GeoJSON Feature тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonGeometry

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonGeometryCollection

Допустимый GeoJSON GeometryCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonLineString

Допустимый GeoJSON LineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiLineString

Допустимый GeoJSON MultiLineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPoint

Допустимый GeoJSON MultiPoint тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPolygon

Допустимый GeoJSON MultiPolygon тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonObjectType

Указывает GeoJSON тип: FeatureCollection.
GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonPolygon

Допустимый GeoJSON Polygon тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
WFSEndpointLink

Ссылки на другие конечные точки WFS

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ExtendedGeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта, расширенный массивом numberReturned и links. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
features

GeoJsonFeature[]

Содержит список допустимых GeoJSON Feature объектов.
links

WFSEndpointLink[]

Ссылки на другие конечные точки WFS.
numberReturned

integer

Количество возвращаемых признаков.
ontology

string

Онтологическая версия этого набора данных.
type

GeoJsonObjectType

Указывает GeoJSON тип: FeatureCollection.

GeoJsonFeature

Допустимый GeoJSON Feature тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
featureType

string

Тип функции. Значение зависит от модели данных, частью этой функции является текущий компонент. Некоторые модели данных могут иметь пустое значение.
geometry GeoJsonGeometry:

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
id

string

Идентификатор компонента.
type string:

Feature

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometry

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
type

GeoJsonObjectType

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometryCollection

Допустимый GeoJSON GeometryCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
geometries GeoJsonGeometry[]:

Содержит список допустимых GeoJSON объектов geometry. Обратите внимание , что координаты в GeoJSON имеют порядок x, y (долгота, широта).
type string:

GeometryCollection

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

Допустимый GeoJSON LineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson LineString .
type string:

LineString

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiLineString

Допустимый GeoJSON MultiLineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiLineString .
type string:

MultiLineString

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPoint

Допустимый GeoJSON MultiPoint тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiPoint .
type string:

MultiPoint

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPolygon

Допустимый GeoJSON MultiPolygon тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Содержит список допустимых GeoJSON Polygon объектов. Обратите внимание , что координаты в GeoJSON имеют порядок x, y (долгота, широта).
type string:

MultiPolygon

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonObjectType

Указывает GeoJSON тип: FeatureCollection.

Имя Тип Описание
FeatureCollection

string

Объект GeoJSON FeatureCollection.

GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

— Position это массив чисел с двумя или более элементами. Первые два элемента — долгота и широта, именно в этом порядке. Высота или высота является необязательным третьим элементом. Дополнительные сведения см. в документе RFC 7946 .
type string:

Point

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPolygon

Допустимый GeoJSON Polygon тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты для GeoJson Polygon типа geometry.
type string:

Polygon

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Ссылки на другие конечные точки WFS

Имя Тип Описание
href

string

Целевой объект ссылки.
hreflang

string

Указание, указывающее, каким должен быть язык результата разыменовки ссылки.
rel

string

Тип отношения.
title

string

Используется для пометки назначения ссылки таким образом, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, записи меню) на языке, указанном полем заголовка Content-Language (при наличии).
type

string

Указание, указывающее тип носителя в результате разыменовки ссылки.