GetCollectionDefinition.json

{
  "parameters": {
    "geography": "us",
    "api-version": "2.0",
    "datasetid": "218fda98-e638-0edf-5ef7-28491ff3bed4",
    "subscription-key": "[subscription-key]",
    "collectionId": "unit"
  },
  "responses": {
    "200": {
      "body": {
        "idPrefix": "UNIT",
        "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.",
        "ontology": "Facility-2.0",
        "geometryType": "Polygon",
        "featureTypes": [],
        "properties": [
          {
            "name": "externalId",
            "required": false,
            "type": "text"
          },
          {
            "name": "originalId",
            "required": false,
            "type": "text"
          },
          {
            "name": "categoryId",
            "required": true,
            "type": {
              "featureId": "category"
            }
          },
          {
            "name": "isOpenArea",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "isRoutable",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "levelId",
            "required": true,
            "type": {
              "featureId": "level"
            }
          },
          {
            "name": "occupants",
            "required": false,
            "type": {
              "array": {
                "featureId": "directoryInfo"
              }
            }
          },
          {
            "name": "addressId",
            "required": false,
            "type": {
              "featureId": "directoryInfo"
            }
          },
          {
            "name": "addressRoomNumber",
            "required": false,
            "type": "text"
          },
          {
            "name": "name",
            "required": false,
            "type": "text"
          },
          {
            "name": "nameSubtitle",
            "required": false,
            "type": "text"
          },
          {
            "name": "nameAlt",
            "required": false,
            "type": "text"
          },
          {
            "name": "anchorPoint",
            "required": false,
            "type": {
              "geometry": [
                "Point"
              ],
              "isFragmented": false,
              "srid": 4326
            }
          }
        ],
        "links": [
          {
            "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
            "rel": "self",
            "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"
          }
        ]
      }
    },
    "400": {
      "headers": {},
      "body": {
        "error": {
          "code": "400 BadRequest",
          "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
        }
      }
    },
    "401": {
      "headers": {},
      "body": {
        "error": {
          "code": "401 Unauthorized",
          "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
        }
      }
    },
    "403": {
      "headers": {},
      "body": {
        "error": {
          "code": "403 Forbidden",
          "message": "Permission, capacity, or authentication issues."
        }
      }
    },
    "404": {
      "headers": {},
      "body": {
        "error": {
          "code": "404 NotFound",
          "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
        }
      }
    },
    "500": {
      "headers": {},
      "body": {
        "error": {
          "code": "500 InternalServerError",
          "message": "An error occurred while processing the request. Please try again later."
        }
      }
    }
  }
}