OpenAPI Specification

Endpoint root: https://integration.mapsindoors.com/

Gets all App-User Roles for the solution

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/appUserRoles'

200

400

401

404

200

[
  {
    "id": "text",
    "names": [
      {
        "language": "text",
        "name": "text"
      }
    ]
  }
]

OK

List all categories in the dataset

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/categories'

200

400

401

404

200

[
  {
    "id": "text",
    "key": "text",
    "name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "icon": "text",
    "imageUrl": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

OK

Create a new category object

post

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

idstring | nullableoptional

keystring | nullableoptional

nameobject | nullableoptional

iconstring | nullableoptional

imageUrlstring | nullableoptional

propertiesobject | nullableoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/{apiKey}/api/categories' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "key": "ENTRANCE",
      "name": {
        "en": "Entrance",
        "da": "Indgang"
      }
    }
  ]'

200

201

400

401

409

200

No body

OK

Update a number of existing categories.

put

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

idstring | nullableoptional

keystring | nullableoptional

nameobject | nullableoptional

iconstring | nullableoptional

imageUrlstring | nullableoptional

propertiesobject | nullableoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/{apiKey}/api/categories' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "5823246d07215b23a02e3cdd",
      "key": "ENTRANCE",
      "name": {
        "en": "Entrance",
        "da": "Indgang"
      }
    }
  ]'

200

204

400

401

404

409

200

No body

OK

Delete existing categories

delete

Only poi geodata can be deleted for now.

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

string[]optional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/{apiKey}/api/categories' \
  --header 'Content-Type: application/json' \
  --data '[
    "db6b07b3f4dd41fba865a5a6"
  ]'

200

400

401

403

200

No body

OK

Get all dataset objects

get

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/dataset'

200

401

200

[
  {
    "id": "text",
    "name": "text",
    "availableLanguages": [
      "text"
    ],
    "baseLanguage": "text",
    "rootObjects": [
      "text"
    ]
  }
]

OK

Get a dataset object with a specific API Key

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/dataset'

200

401

200

{
  "id": "text",
  "name": "text",
  "availableLanguages": [
    "text"
  ],
  "baseLanguage": "text",
  "rootObjects": [
    "text"
  ]
}

OK

Get all dataset Ids for a given customer

get

Oauth2 Roles

• Requires user to have one of the following roles: owner, service

Authorizations

Query parameters

customerIdstringrequired

The customer ID to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/dataset/customer?customerId=text'

200

401

403

200

[
  "db6b07b3f4dd41fba865a5a6"
]

OK

Default route. Can be used for testing if the service is running.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/'

200

200

{}

OK

Get a location type objects from a given solution

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/displaytypes'

200

401

200

[
  {
    "id": "text",
    "name": "text",
    "displayRules": [
      {
        "name": "text",
        "iconUrl": "text",
        "iconScale": 1,
        "iconSize": {
          "width": 1,
          "height": 1
        },
        "iconPlacement": 0,
        "labelTemplate": "text",
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "labelZoomFrom": 1,
        "labelZoomTo": 1,
        "labelMaxWidth": 1,
        "iconVisible": true,
        "labelVisible": true,
        "polygon": {
          "visible": true,
          "zoomFrom": 1,
          "zoomTo": 1,
          "strokeWidth": 1,
          "strokeColor": "text",
          "strokeOpacity": 1,
          "fillColor": "text",
          "fillOpacity": 1,
          "lightnessFactor": 1
        },
        "markerElevation": 1,
        "walls": {
          "visible": true,
          "height": 1,
          "color": "text",
          "zoomFrom": 1,
          "zoomTo": 1,
          "lightnessFactor": 1
        },
        "extrusion": {
          "visible": true,
          "height": 1,
          "color": "text",
          "zoomFrom": 1,
          "zoomTo": 1,
          "lightnessFactor": 1
        },
        "model3D": {
          "visible": true,
          "zoomFrom": 1,
          "zoomTo": 1,
          "model": "text",
          "rotationX": 1,
          "rotationY": 1,
          "rotationZ": 1,
          "scale": 1
        },
        "model2D": {
          "visible": true,
          "zoomFrom": 1,
          "zoomTo": 1,
          "model": "text",
          "widthMeters": 1,
          "heightMeters": 1,
          "bearing": 1
        },
        "badge": {
          "visible": true,
          "zoomFrom": 1,
          "zoomTo": 1,
          "radius": 1,
          "strokeWidth": 1,
          "strokeColor": "text",
          "fillColor": "text",
          "scale": 1,
          "position": 0
        },
        "labelStyle": {
          "textSize": 1,
          "textColor": "text",
          "textOpacity": 1,
          "haloColor": "text",
          "haloWidth": 1,
          "haloBlur": 1,
          "bearing": 1,
          "graphic": {
            "backgroundImage": "text",
            "stretchX": [
              [
                1
              ]
            ],
            "stretchY": [
              [
                1
              ]
            ],
            "content": [
              1
            ]
          },
          "labelPosition": 0
        },
        "labelType": 0
      }
    ],
    "propertyTemplates": [
      {
        "text": "text",
        "type": "text",
        "defaultValue": [
          "text"
        ]
      }
    ],
    "aliases": [
      "text"
    ],
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "restrictions": [
      "text"
    ]
  }
]

OK

Create a new display type object

post

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

idstring | nullableoptional

namestring | nullableoptional

displayRulesobject[] | nullableoptional

propertyTemplatesobject[] | nullableoptional

aliasesstring[] | nullableoptional

propertiesobject | nullableoptional

restrictionsstring[] | nullableoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/{apiKey}/api/displaytypes' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "name": "Entrance",
      "displayRules": [
        {
          "name": "default",
          "iconUrl": "https://app.mapsindoors.com/mapsindoors/gfx/bella/80/Entrance.png",
          "visible": true,
          "zoomFrom": 17,
          "zoomTo": 21,
          "labelZoomFrom": 17,
          "labelZoomTo": 21
        }
      ],
      "properties": {
        "name@en": "Entrance",
        "name@da": "Indgang"
      }
    }
  ]'

200

201

400

401

409

200

No body

OK

Update a number of existing DisplayTypes.

put

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

idstring | nullableoptional

namestring | nullableoptional

displayRulesobject[] | nullableoptional

propertyTemplatesobject[] | nullableoptional

aliasesstring[] | nullableoptional

propertiesobject | nullableoptional

restrictionsstring[] | nullableoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/{apiKey}/api/displaytypes' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "0a7533a062e84ed0a72a621a",
      "name": "Entrance",
      "displayRules": [
        {
          "name": "default",
          "iconUrl": "https://app.mapsindoors.com/mapsindoors/gfx/bella/80/Entrance.png",
          "visible": true,
          "zoomFrom": 17,
          "zoomTo": 21,
          "labelZoomFrom": 17,
          "labelZoomTo": 21
        }
      ],
      "properties": {
        "name@en": "Entrance",
        "name@da": "Indgang"
      }
    }
  ]'

200

204

400

401

404

409

200

No body

OK

Delete existing DisplayTypes

delete

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

string[]optional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/{apiKey}/api/displaytypes' \
  --header 'Content-Type: application/json' \
  --data '[
    "db6b07b3f4dd41fba865a5a6"
  ]'

200

400

401

403

200

No body

OK

Get a mapping for a specific solution

get

Path parameters

datasetIdstring · default: "92553b2f03794e9ea1521227"required

The dataset ID to use

Query parameters

originIdstring · default: "ubiqisense"optional

(Optional) If not given id's will only match geodata with matching externalId. If set IDs will be found from the mapExternalId table

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{datasetId}/api/geodata/mapExternalId'

200

400

401

200

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "id": "text",
      "path": {
        "datasetId": "text",
        "venueId": "text",
        "buildingId": "text",
        "floorId": "text",
        "floorIndex": "text",
        "roomId": "text",
        "locationId": "text"
      },
      "baseType": "text"
    }
  ]
}

OK

Get a mapping from Ids to Paths for all datasets for a customer. Will go though all solutions for the given customer.

get

Oauth2 Roles

• Requires user to have one of the following roles: owner, service

Authorizations

Query parameters

customerIdstring · default: "5583d3582a91e00f1cc4ecb1"required

The customer ID to use

originIdstring · default: "ubiqisense"optional

(Optional) Livedata source origin (eg. "ubiqisense"). If not given id's will only match geodata with matching externalId. If set IDs will be found from the mapExternalId table

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/geodata/mapExternalId/customer?customerId=text'

200

400

401

200

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "id": "text",
        "path": {
          "datasetId": "text",
          "venueId": "text",
          "buildingId": "text",
          "floorId": "text",
          "floorIndex": "text",
          "roomId": "text",
          "locationId": "text"
        },
        "baseType": "text"
      }
    ]
  }
}

OK

Get a reverse geopoint: Figure out which geodata is at a given point (if any)

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

API Key

Query parameters

latnumber · double · default: "57.086001"required

Latitude of the point to examine. Valid range: +/- 90

lngnumber · double · default: "9.957824"required

Longitude of the point to examine. Valid range: +/- 180

floorinteger · int32 · default: "0"required

Floor index to examine

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/geocode?lat=1&lng=1&floor=1'

200

400

403

404

200

[
  {
    "id": "text",
    "parentId": "text",
    "datasetId": "text",
    "externalId": "text",
    "baseType": "text",
    "displayTypeId": "text",
    "displaySetting": {
      "name": "text",
      "iconUrl": "text",
      "iconScale": 1,
      "iconSize": {
        "width": 1,
        "height": 1
      },
      "iconPlacement": 0,
      "labelTemplate": "text",
      "visible": true,
      "zoomFrom": 1,
      "zoomTo": 1,
      "labelZoomFrom": 1,
      "labelZoomTo": 1,
      "labelMaxWidth": 1,
      "iconVisible": true,
      "labelVisible": true,
      "polygon": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "strokeWidth": 1,
        "strokeColor": "text",
        "strokeOpacity": 1,
        "fillColor": "text",
        "fillOpacity": 1,
        "lightnessFactor": 1
      },
      "markerElevation": 1,
      "walls": {
        "visible": true,
        "height": 1,
        "color": "text",
        "zoomFrom": 1,
        "zoomTo": 1,
        "lightnessFactor": 1
      },
      "extrusion": {
        "visible": true,
        "height": 1,
        "color": "text",
        "zoomFrom": 1,
        "zoomTo": 1,
        "lightnessFactor": 1
      },
      "model3D": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "model": "text",
        "rotationX": 1,
        "rotationY": 1,
        "rotationZ": 1,
        "scale": 1
      },
      "model2D": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "model": "text",
        "widthMeters": 1,
        "heightMeters": 1,
        "bearing": 1
      },
      "badge": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "radius": 1,
        "strokeWidth": 1,
        "strokeColor": "text",
        "fillColor": "text",
        "scale": 1,
        "position": 0
      },
      "labelStyle": {
        "textSize": 1,
        "textColor": "text",
        "textOpacity": 1,
        "haloColor": "text",
        "haloWidth": 1,
        "haloBlur": 1,
        "bearing": 1,
        "graphic": {
          "backgroundImage": "text",
          "stretchX": [
            [
              1
            ]
          ],
          "stretchY": [
            [
              1
            ]
          ],
          "content": [
            1
          ]
        },
        "labelPosition": 0
      },
      "labelType": 0
    },
    "geometry": {
      "type": 0
    },
    "anchor": {
      "type": 0,
      "coordinates": [
        1
      ]
    },
    "aliases": [
      "text"
    ],
    "categories": [
      "text"
    ],
    "status": 0,
    "baseTypeProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "tilesUrl": "text",
    "tileStyles": [
      {
        "displayName": "text",
        "style": "text"
      }
    ]
  }
]

OK

Get geodata objects from a given dataset

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Query parameters

rootElementsstring · default: "5548c6583eb3c3080c4a92da"optional

(Optional) Filter the output so only elements with ancestors matches a root element is returned

baseTypesstring · default: "poi"optional

(Optional) Filter the output so only elements of the given type is returned. Supported values: "poi", "room", "floor", "building", "venue", "area"

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/geodata'

200

400

401

200

[
  {
    "id": "text",
    "parentId": "text",
    "datasetId": "text",
    "externalId": "text",
    "baseType": "text",
    "displayTypeId": "text",
    "displaySetting": {
      "name": "text",
      "iconUrl": "text",
      "iconScale": 1,
      "iconSize": {
        "width": 1,
        "height": 1
      },
      "iconPlacement": 0,
      "labelTemplate": "text",
      "visible": true,
      "zoomFrom": 1,
      "zoomTo": 1,
      "labelZoomFrom": 1,
      "labelZoomTo": 1,
      "labelMaxWidth": 1,
      "iconVisible": true,
      "labelVisible": true,
      "polygon": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "strokeWidth": 1,
        "strokeColor": "text",
        "strokeOpacity": 1,
        "fillColor": "text",
        "fillOpacity": 1,
        "lightnessFactor": 1
      },
      "markerElevation": 1,
      "walls": {
        "visible": true,
        "height": 1,
        "color": "text",
        "zoomFrom": 1,
        "zoomTo": 1,
        "lightnessFactor": 1
      },
      "extrusion": {
        "visible": true,
        "height": 1,
        "color": "text",
        "zoomFrom": 1,
        "zoomTo": 1,
        "lightnessFactor": 1
      },
      "model3D": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "model": "text",
        "rotationX": 1,
        "rotationY": 1,
        "rotationZ": 1,
        "scale": 1
      },
      "model2D": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "model": "text",
        "widthMeters": 1,
        "heightMeters": 1,
        "bearing": 1
      },
      "badge": {
        "visible": true,
        "zoomFrom": 1,
        "zoomTo": 1,
        "radius": 1,
        "strokeWidth": 1,
        "strokeColor": "text",
        "fillColor": "text",
        "scale": 1,
        "position": 0
      },
      "labelStyle": {
        "textSize": 1,
        "textColor": "text",
        "textOpacity": 1,
        "haloColor": "text",
        "haloWidth": 1,
        "haloBlur": 1,
        "bearing": 1,
        "graphic": {
          "backgroundImage": "text",
          "stretchX": [
            [
              1
            ]
          ],
          "stretchY": [
            [
              1
            ]
          ],
          "content": [
            1
          ]
        },
        "labelPosition": 0
      },
      "labelType": 0
    },
    "geometry": {
      "type": 0
    },
    "anchor": {
      "type": 0,
      "coordinates": [
        1
      ]
    },
    "aliases": [
      "text"
    ],
    "categories": [
      "text"
    ],
    "status": 0,
    "baseTypeProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "tilesUrl": "text",
    "tileStyles": [
      {
        "displayName": "text",
        "style": "text"
      }
    ]
  }
]

OK

Create one or more new geodata objects

post

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

idstring | nullableoptional

lastModifiedstring · date-time | nullableoptional

lastModifiedBystring | nullableoptional

createdAtstring · date-time | nullableoptional

createdBystring | nullableoptional

parentIdstring | nullableoptional

datasetIdstring | nullableoptional

externalIdstring | nullableoptional

solutionIdstring | nullableoptional

baseTypestring | nullableoptional

displayTypeIdstring | nullableoptional

displaySettingall of | nullableoptional

geometryall of | nullableoptional

anchorall of | nullableoptional

aliasesstring[] | nullableoptional

categoriesstring[] | nullableoptional

statusall ofoptional

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

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 | nullableoptional

propertiesobject | nullableoptional

tilesUrlstring | nullableoptional

tileStylesobject[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/{apiKey}/api/geodata' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "parentId": "34c588fecbee45f199e8d67c",
      "datasetId": "550c26a864617400a40f0000",
      "solutionId": "550c26a864617400a40f0000",
      "baseType": "poi",
      "displayTypeId": "b6356efe8f044766979f70cf",
      "displaySetting": {
        "name": "default"
      },
      "geometry": {
        "coordinates": [
          9.957280663317908,
          57.08613355600178
        ],
        "type": "Point"
      },
      "anchor": {
        "coordinates": [
          9.957280663317908,
          57.08613355600178
        ],
        "type": "Point"
      },
      "aliases": [],
      "categories": [
        "5823246d07215b23a02e3cd8"
      ],
      "status": 3,
      "baseTypeProperties": {
        "administrativeid": "9213bd5a-e335-4ee4-8465-2a7ef3491e94",
        "imageurl": "https://tiles.mapsindoors.com/tiles/indoor/rtx/mapspeople.png",
        "capacity": "0"
      },
      "properties": {
        "website@da": "my.website.com",
        "email@da": "[e-mail]",
        "phone@da": "555 1234567",
        "samplekey@da": "samplevalue",
        "name@da": "Sample infodesk (Danish)",
        "description@da": "Sample description for this information desk (Danish)",
        "website@en": "my.website.com",
        "email@en": "[e-mail]",
        "phone@en": "555 1234567",
        "samplekey@en": "samplevalue",
        "name@en": "Sample infodesk (English)",
        "description@en": "Sample description for this information desk (English)"
      }
    }
  ]'

200

201

400

401

200

[
  "db6b07b3f4dd41fba865a5a6"
]

OK

Update a number of existing geodata.

put

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

Other propertiesobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/{apiKey}/api/geodata' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "parentId": "34c588fecbee45f199e8d67c",
      "datasetId": "550c26a864617400a40f0000",
      "solutionId": "550c26a864617400a40f0000",
      "baseType": "poi",
      "displayTypeId": "b6356efe8f044766979f70cf",
      "displaySetting": {
        "name": "default"
      },
      "geometry": {
        "coordinates": [
          9.957280663317908,
          57.08613355600178
        ],
        "type": "Point"
      },
      "anchor": {
        "coordinates": [
          9.957280663317908,
          57.08613355600178
        ],
        "type": "Point"
      },
      "aliases": [],
      "categories": [
        "5823246d07215b23a02e3cd8"
      ],
      "status": 3,
      "baseTypeProperties": {
        "administrativeid": "9213bd5a-e335-4ee4-8465-2a7ef3491e94",
        "imageurl": "https://tiles.mapsindoors.com/tiles/indoor/rtx/mapspeople.png",
        "capacity": "0"
      },
      "properties": {
        "website@da": "my.website.com",
        "email@da": "[e-mail]",
        "phone@da": "555 1234567",
        "samplekey@da": "samplevalue",
        "name@da": "Sample infodesk (Danish)",
        "description@da": "Sample description for this information desk (Danish)",
        "website@en": "my.website.com",
        "email@en": "[e-mail]",
        "phone@en": "555 1234567",
        "samplekey@en": "samplevalue",
        "name@en": "Sample infodesk (English)",
        "description@en": "Sample description for this information desk (English)"
      },
      "id": "f441e4799b0f4c1ea2ea042b"
    }
  ]'

200

204

400

401

404

409

200

No body

OK

Delete existing geodata

delete

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

string[]optional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/{apiKey}/api/geodata' \
  --header 'Content-Type: application/json' \
  --data '[
    "db6b07b3f4dd41fba865a5a6"
  ]'

200

400

401

403

200

No body

OK

Place 2d models for rooms and area geodata

post

A 2d model must be available in the geodata referenced to before it can be placed

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Query parameters

rectFitModeall of · default: "trendingAngle"optional

A number of ways to fit an image to a given polygon.

A number of ways to fit an image to a given polygon.

Body

idstring | nullableoptional

widthnumber · doubleoptional

heightnumber · doubleoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/{apiKey}/api/geodata/place2dmodel' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "6691bf61342c46c8a039397c",
      "width": 98,
      "height": 514
    }
  ]'

200

400

401

403

200

No body

OK

Drops all (generated) graphs for a given solution causing the graph for these to be re-calculated

delete

Oauth2 Roles

• Requires user to have the role: owner

Authorizations

Path parameters

apiKeystring · default: "e718136997bb479b801d7146"required

The API Key to use

Query parameters

graphIdstring · default: nulloptional

(Optional) If set, only this graph will be deleted

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/{apiKey}/api/graphs/graph'

200

200

No body

OK

Get a list of graphs in a solution

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/routing/graphs'

200

400

401

404

200

[
  "db6b07b3f4dd41fba865a5a6"
]

OK

Get a list of route elements for a given graph

get

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Query parameters

graphIdstring · default: "RTX_Graph"required

The graphId to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/{apiKey}/api/routing/routeelements?graphId=text'

200

400

401

404

200

[
  {
    "id": "text",
    "datasetId": "text",
    "externalId": "text",
    "geometry": {
      "type": 0
    },
    "restrictions": [
      "text"
    ],
    "onewayDirection": 1,
    "waitTime": 1
  }
]

OK

Update WaitTime, Restrictions and OnewayDirection data for a number of route element(s)

put

Oauth2 Roles

• Requires user to have one of the following roles: admin, editor, owner, service

Authorizations

Path parameters

apiKeystring · default: "550c26a864617400a40f0000"required

The API Key to use

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

idstring | nullableoptional

datasetIdstring | nullableoptional

externalIdstring | nullableoptional

UUID of this element as an extern ID

geometryall of | nullableoptional

geoJSON point where this element is placed

restrictionsstring[] | nullableoptional

(Optional) IF set - one or more of these tokens will be needed to traverse this area

onewayDirectionnumber · double | nullableoptional

(Optional) IF set - end users may only walk in the direction stated within the area (+/- 90 degrees)

waitTimeinteger · int32 | nullableoptional

(Optional) IF set (to a positive number) end users will be asked to wait this additional amount of seconds here.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/{apiKey}/api/routing/routeelements' \
  --header 'Content-Type: application/json-patch+json' \
  --data '[
    {
      "id": "79edd6bb64724381bbf43923",
      "datasetId": "550c26a864617400a40f0000",
      "geometry": {
        "coordinates": [
          9.95721348677762,
          57.0860020274923
        ],
        "type": "Point"
      },
      "restrictions": [
        "locked"
      ],
      "waitTime": 0
    }
  ]'

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

400

401

404

200

No body

OK