Sign in
latestOpenAPI 3.0.12026-08-10263778.5 KB

7f2454dc70d5

Geodata

Get geodata objects from a given dataset.

get/{apiKey}/api/geodata

Path parameters

apiKeystring required

The API key to use.

Query parameters

rootElementsstring

(Optional) A comma-separated list of geodata identifiers, that filter the output so that only elements that have ancestors with a matching root element are returned.

baseTypesstring

(Optional) A comma-separated list of base types, that filter the output so that only elements of the given base types are returned. Supported values: "poi", "room", "floor", "building", "venue", and "area".

externalIdsstring

(Optional) A comma-separated list of external identifiers, that filter the output so that only elements with the given external identifiers are returned.

displayTypeNamesstring

(Optional) A comma-separated list of display type names, that filter the output so that only elements with the given display type names (case-insensitive) are returned. Display type names are also known as location type administrative identifiers in the MapsIndoors CMS.

Response

OK

idstring nullable
parentIdstring nullable
datasetIdstring nullable
externalIdstring nullable
baseTypestring nullable
displayTypeIdstring nullable
aliasesstring[] nullable
categoriesstring[] nullable
status0 | 1 | 2

Bit 1: Active. Bit 2: Searchable. For Locations Status.Active is not used in never SDKs, it is overwritten with bool from evaluating if the current time is between ActiveFrom-ActiveTo. Searchable is used

baseTypePropertiesobject nullable
propertiesobject nullable
tilesUrlstring nullable