OpenAPI Specification

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

Gets all App-User Roles for the solution

GET/{apiKey}/api/appUserRoles

Path parameters

apiKey*string

The API Key to use

Response

200400401404

OK

Body

application/json

idnullable string

namesnullable array of NamedTranslation (object)

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/appUserRoles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

List all categories in the dataset

GET/{apiKey}/api/categories

Path parameters

apiKey*string

The API Key to use

Response

200400401404

OK

Body

application/json

idnullable string

keynullable string

namenullable object

iconnullable string

imageUrlnullable string

propertiesnullable object

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a new category object

Oauth2 Roles

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

POST/{apiKey}/api/categories

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

idnullable string

keynullable string

namenullable object

iconnullable string

imageUrlnullable string

propertiesnullable object

Response

200201400401409

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "key": "ENTRANCE",
        "name": {
          "en": "Entrance",
          "da": "Indgang"
        }
      }
    ]),
});
const data = await response.json();

Update a number of existing categories.

Oauth2 Roles

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

PUT/{apiKey}/api/categories

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

A list of updated geodata

idnullable string

keynullable string

namenullable object

iconnullable string

imageUrlnullable string

propertiesnullable object

Response

200204400401404409

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/categories', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "5823246d07215b23a02e3cdd",
        "key": "ENTRANCE",
        "name": {
          "en": "Entrance",
          "da": "Indgang"
        }
      }
    ]),
});
const data = await response.json();

Delete existing categories

Only poi geodata can be deleted for now.

Oauth2 Roles

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

DELETE/{apiKey}/api/categories

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

An array of Category IDs

itemsstring

Response

200400401403

OK

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/categories', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "db6b07b3f4dd41fba865a5a6"
    ]),
});
const data = await response.json();

Get all dataset objects

Oauth2 Roles

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

GET/api/dataset

Authorization

account

Response

200401

OK

Body

application/json

idnullable string

namenullable string

availableLanguagesnullable array of string

baseLanguagenullable string

rootObjectsnullable array of string

Request

JavaScriptCurlPython

const response = await fetch('/api/dataset', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get a dataset object with a specific API Key

GET/{apiKey}/api/dataset

Path parameters

apiKey*string

The API Key to use

Response

200401

OK

Body

application/json

idnullable string

namenullable string

availableLanguagesnullable array of string

baseLanguagenullable string

rootObjectsnullable array of string

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/dataset', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get all dataset Ids for a given customer

Oauth2 Roles

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

GET/api/dataset/customer

Authorization

account

Query parameters

Response

200401403

OK

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/api/dataset/customer?customerId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  "text"
]

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

GET/

Response

200

OK

Body

application/json

VersionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get a location type objects from a given solution

GET/{apiKey}/api/displaytypes

Path parameters

apiKey*string

The API Key to use

Response

200401

OK

Body

application/json

idnullable string

namenullable string

displayRulesnullable array of DisplaySetting (object)

propertyTemplatesnullable array of PropertyTemplate (object)

aliasesnullable array of string

propertiesnullable object

restrictionsnullable array of string

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/displaytypes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a new display type object

Oauth2 Roles

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

POST/{apiKey}/api/displaytypes

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

idnullable string

namenullable string

displayRulesnullable array of DisplaySetting (object)

propertyTemplatesnullable array of PropertyTemplate (object)

aliasesnullable array of string

propertiesnullable object

restrictionsnullable array of string

Response

200201400401409

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/displaytypes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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"
        }
      }
    ]),
});
const data = await response.json();

Update a number of existing DisplayTypes.

Oauth2 Roles

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

PUT/{apiKey}/api/displaytypes

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

A list of updated geodata

idnullable string

namenullable string

displayRulesnullable array of DisplaySetting (object)

propertyTemplatesnullable array of PropertyTemplate (object)

aliasesnullable array of string

propertiesnullable object

restrictionsnullable array of string

Response

200204400401404409

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/displaytypes', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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"
        }
      }
    ]),
});
const data = await response.json();

Delete existing DisplayTypes

Oauth2 Roles

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

DELETE/{apiKey}/api/displaytypes

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

An array of DisplayType IDs

itemsstring

Response

200400401403

OK

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/displaytypes', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "db6b07b3f4dd41fba865a5a6"
    ]),
});
const data = await response.json();

Get a mapping for a specific solution

GET/{datasetId}/api/geodata/mapExternalId

Path parameters

datasetId*string

The dataset ID to use

Query parameters

Response

200400401

OK

Body

application/json

Other propertiesarray of PathMapping (object)

Request

JavaScriptCurlPython

const response = await fetch('/{datasetId}/api/geodata/mapExternalId', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

Oauth2 Roles

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

GET/api/geodata/mapExternalId/customer

Authorization

account

Query parameters

Response

200400401

OK

Body

application/json

Other propertiesobject

Request

JavaScriptCurlPython

const response = await fetch('/api/geodata/mapExternalId/customer?customerId=5583d3582a91e00f1cc4ecb1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

GET/{apiKey}/api/geocode

Path parameters

apiKey*string

API Key

Query parameters

Response

200400403404

OK

Body

application/json

idnullable string

parentIdnullable string

datasetIdnullable string

externalIdnullable string

baseTypenullable string

displayTypeIdnullable string

displaySettingDisplaySetting (object)

geometryGeometry (object)

anchorPoint (object)

aliasesnullable array of string

categoriesnullable array of string

statusStatus (enum)

012

baseTypePropertiesnullable object

propertiesnullable object

tilesUrlnullable string

tileStylesnullable array of TileStyle (object)

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geocode?lat=57.086001&lng=9.957824', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get geodata objects from a given dataset

GET/{apiKey}/api/geodata

Path parameters

apiKey*string

The API Key to use

Query parameters

Response

200400401

OK

Body

application/json

idnullable string

parentIdnullable string

datasetIdnullable string

externalIdnullable string

baseTypenullable string

displayTypeIdnullable string

displaySettingDisplaySetting (object)

geometryGeometry (object)

anchorPoint (object)

aliasesnullable array of string

categoriesnullable array of string

statusStatus (enum)

012

baseTypePropertiesnullable object

propertiesnullable object

tilesUrlnullable string

tileStylesnullable array of TileStyle (object)

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geodata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create one or more new geodata objects

Only poi geodata can be created for now

Oauth2 Roles

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

POST/{apiKey}/api/geodata

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

The data for the new geodata

idnullable string

lastModifiednullable string (date-time)

lastModifiedBynullable string

createdAtnullable string (date-time)

createdBynullable string

parentIdnullable string

datasetIdnullable string

externalIdnullable string

solutionIdnullable string

baseTypenullable string

displayTypeIdnullable string

displaySettingDisplaySetting (object)

geometryGeometry (object)

anchorPoint (object)

aliasesnullable array of string

categoriesnullable array of string

statusStatus (enum)

012

baseTypePropertiesnullable object

propertiesnullable object

tilesUrlnullable string

tileStylesnullable array of TileStyle (object)

Response

200201400401

Success

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geodata', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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)"
        }
      }
    ]),
});
const data = await response.json();

Response

200

[
  "text"
]

Update a number of existing geodata.

Only poi and room geodata can be updated for now

Oauth2 Roles

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

PUT/{apiKey}/api/geodata

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

A list of updated geodata

Other propertiesGeodataCompositeValue (object)

Response

200204400401404409

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geodata', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "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"
      }
    ]),
});
const data = await response.json();

Delete existing geodata

Only poi geodata can be deleted for now.

Oauth2 Roles

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

DELETE/{apiKey}/api/geodata

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

application/json

An array of Geodata IDs

itemsstring

Response

200400401403

OK

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geodata', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "db6b07b3f4dd41fba865a5a6"
    ]),
});
const data = await response.json();

Place 2d models for rooms and area geodata

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

POST/{apiKey}/api/geodata/place2dmodel

Authorization

account

Path parameters

apiKey*string

The API Key to use

Query parameters

Body

application/json

An array of Geodata IDs

idnullable string

widthnumber (double)

heightnumber (double)

Response

200400401403

OK

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/geodata/place2dmodel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "6691bf61342c46c8a039397c",
        "width": 98,
        "height": 514
      }
    ]),
});
const data = await response.json();

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

Oauth2 Roles

• Requires user to have the role: owner

DELETE/{apiKey}/api/graphs/graph

Authorization

account

Path parameters

apiKey*string

The API Key to use

Query parameters

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/graphs/graph', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get a list of graphs in a solution

GET/{apiKey}/api/routing/graphs

Path parameters

apiKey*string

The API Key to use

Response

200400401404

OK

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/routing/graphs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  "text"
]

Get a list of route elements for a given graph

GET/{apiKey}/api/routing/routeelements

Path parameters

apiKey*string

The API Key to use

Query parameters

Response

200400401404

OK

Body

application/json

idnullable string

datasetIdnullable string

externalIdnullable string

UUID of this element as an extern ID

geometryGeometry (object)

restrictionsnullable array of string

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

onewayDirectionnullable number (double)

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

waitTimenullable integer (int32)

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

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/routing/routeelements?graphId=RTX_Graph', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

Oauth2 Roles

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

PUT/{apiKey}/api/routing/routeelements

Authorization

account

Path parameters

apiKey*string

The API Key to use

Body

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

idnullable string

datasetIdnullable string

externalIdnullable string

UUID of this element as an extern ID

geometryGeometry (object)

restrictionsnullable array of string

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

onewayDirectionnullable number (double)

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

waitTimenullable integer (int32)

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

Response

200400401404

OK

Request

JavaScriptCurlPython

const response = await fetch('/{apiKey}/api/routing/routeelements', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify([
      {
        "id": "79edd6bb64724381bbf43923",
        "datasetId": "550c26a864617400a40f0000",
        "geometry": {
          "coordinates": [
            9.95721348677762,
            57.0860020274923
          ],
          "type": "Point"
        },
        "restrictions": [
          "locked"
        ],
        "waitTime": 0
      }
    ]),
});
const data = await response.json();