CMSGitHubSupportBook a demo

OpenAPI Specification

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

Gets all App-User Roles for the solution

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Responses
200
OK
application/json
get
GET /{apiKey}/api/appUserRoles HTTP/1.1
Host: 
Accept: */*

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

List all categories in the dataset

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Responses
200
OK
application/json
get
GET /{apiKey}/api/categories HTTP/1.1
Host: 
Accept: */*

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

Create a new category object

post

Oauth2 Roles

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

The API Key to use

Default: 550c26a864617400a40f0000
Body
idstring | nullableOptional
keystring | nullableOptional
iconstring | nullableOptional
imageUrlstring | nullableOptional
Responses
200
OK
post
POST /{apiKey}/api/categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

[
  {
    "key": "ENTRANCE",
    "name": {
      "en": "Entrance",
      "da": "Indgang"
    }
  }
]
No content

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
idstring | nullableOptional
keystring | nullableOptional
iconstring | nullableOptional
imageUrlstring | nullableOptional
Responses
200
OK
put
PUT /{apiKey}/api/categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

[
  {
    "id": "5823246d07215b23a02e3cdd",
    "key": "ENTRANCE",
    "name": {
      "en": "Entrance",
      "da": "Indgang"
    }
  }
]
No content

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
string[]Optional
Responses
200
OK
delete
DELETE /{apiKey}/api/categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

[
  "db6b07b3f4dd41fba865a5a6"
]
No content

Get all dataset objects

get

Oauth2 Roles

  • Requires user to have one of the following roles: admin, editor, owner, service
Authorizations
Responses
200
OK
application/json
get
GET /api/dataset HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get a dataset object with a specific API Key

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Responses
200
OK
application/json
get
GET /{apiKey}/api/dataset HTTP/1.1
Host: 
Accept: */*

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

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
200
OK
application/json
Responsestring[]
get
GET /api/dataset/customer?customerId=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "db6b07b3f4dd41fba865a5a6"
]

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

get
Responses
200
OK
application/json
Responseobject
get
GET / HTTP/1.1
Host: 
Accept: */*
200

OK

{}

Get a location type objects from a given solution

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Responses
200
OK
application/json
get
GET /{apiKey}/api/displaytypes HTTP/1.1
Host: 
Accept: */*

[
  {
    "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"
    ]
  }
]

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
idstring | nullableOptional
namestring | nullableOptional
aliasesstring[] | nullableOptional
restrictionsstring[] | nullableOptional
Responses
200
OK
post
POST /{apiKey}/api/displaytypes HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268

[
  {
    "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"
    }
  }
]
No content

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
idstring | nullableOptional
namestring | nullableOptional
aliasesstring[] | nullableOptional
restrictionsstring[] | nullableOptional
Responses
200
OK
put
PUT /{apiKey}/api/displaytypes HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

[
  {
    "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"
    }
  }
]
No content

Delete existing DisplayTypes

delete

Oauth2 Roles

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

The API Key to use

Default: 550c26a864617400a40f0000
Body
string[]Optional
Responses
200
OK
delete
DELETE /{apiKey}/api/displaytypes HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

[
  "db6b07b3f4dd41fba865a5a6"
]
No content

Get a mapping for a specific solution

get
Path parameters
datasetIdstringRequired

The dataset ID to use

Default: 92553b2f03794e9ea1521227
Query parameters
originIdstringOptional

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

Default: ubiqisense
Responses
200
OK
application/json
get
GET /{datasetId}/api/geodata/mapExternalId HTTP/1.1
Host: 
Accept: */*

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

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
customerIdstringRequired

The customer ID to use

Default: 5583d3582a91e00f1cc4ecb1
originIdstringOptional

(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

Default: ubiqisense
Responses
200
OK
application/json
get
GET /api/geodata/mapExternalId/customer?customerId=5583d3582a91e00f1cc4ecb1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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"
      }
    ]
  }
}

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

get
Path parameters
apiKeystringRequired

API Key

Default: 550c26a864617400a40f0000
Query parameters
latnumber · doubleRequired

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

Default: 57.086001
lngnumber · doubleRequired

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

Default: 9.957824
floorinteger · int32Required

Floor index to examine

Default: 0
Responses
200
OK
application/json
get
GET /{apiKey}/api/geocode?lat=57.086001&lng=9.957824&floor=0 HTTP/1.1
Host: 
Accept: */*

[
  {
    "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"
      }
    ]
  }
]

Get geodata objects from a given dataset

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Query parameters
rootElementsstringOptional

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

Default: 5548c6583eb3c3080c4a92da
baseTypesstringOptional

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

Default: poi
Responses
200
OK
application/json
get
GET /{apiKey}/api/geodata HTTP/1.1
Host: 
Accept: */*

[
  {
    "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"
      }
    ]
  }
]

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
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

integer · enumOptional

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

Possible values:
tilesUrlstring | nullableOptional
Responses
200
OK
application/json
Responsestring[]
post
POST /{apiKey}/api/geodata HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1078

[
  {
    "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": "[email protected]",
      "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": "[email protected]",
      "phone@en": "555 1234567",
      "samplekey@en": "samplevalue",
      "name@en": "Sample infodesk (English)",
      "description@en": "Sample description for this information desk (English)"
    }
  }
]
[
  "db6b07b3f4dd41fba865a5a6"
]

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
Responses
200
OK
put
PUT /{apiKey}/api/geodata HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1110

[
  {
    "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": "[email protected]",
      "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": "[email protected]",
      "phone@en": "555 1234567",
      "samplekey@en": "samplevalue",
      "name@en": "Sample infodesk (English)",
      "description@en": "Sample description for this information desk (English)"
    },
    "id": "f441e4799b0f4c1ea2ea042b"
  }
]
No content

Delete existing geodata

delete

Oauth2 Roles

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

The API Key to use

Default: 550c26a864617400a40f0000
Body
string[]Optional
Responses
200
OK
delete
DELETE /{apiKey}/api/geodata HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

[
  "db6b07b3f4dd41fba865a5a6"
]
No content

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Query parameters
rectFitModeall ofOptional

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

Default: trendingAngle
string · enumOptional

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

Possible values:
Body
idstring | nullableOptional
widthnumber · doubleOptional
heightnumber · doubleOptional
Responses
200
OK
post
POST /{apiKey}/api/geodata/place2dmodel HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

[
  {
    "id": "6691bf61342c46c8a039397c",
    "width": 98,
    "height": 514
  }
]
No content

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
apiKeystringRequired

The API Key to use

Default: e718136997bb479b801d7146
Query parameters
graphIdstringOptional

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

Default: null
Responses
200
OK
delete
DELETE /{apiKey}/api/graphs/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

No content

Get a list of graphs in a solution

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Responses
200
OK
application/json
Responsestring[]
get
GET /{apiKey}/api/routing/graphs HTTP/1.1
Host: 
Accept: */*

[
  "db6b07b3f4dd41fba865a5a6"
]

Get a list of route elements for a given graph

get
Path parameters
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Query parameters
graphIdstringRequired

The graphId to use

Default: RTX_Graph
Responses
200
OK
application/json
get
GET /{apiKey}/api/routing/routeelements?graphId=RTX_Graph HTTP/1.1
Host: 
Accept: */*

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

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
apiKeystringRequired

The API Key to use

Default: 550c26a864617400a40f0000
Body
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
200
OK
put
PUT /{apiKey}/api/routing/routeelements HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 191

[
  {
    "id": "79edd6bb64724381bbf43923",
    "datasetId": "550c26a864617400a40f0000",
    "geometry": {
      "coordinates": [
        9.95721348677762,
        57.0860020274923
      ],
      "type": "Point"
    },
    "restrictions": [
      "locked"
    ],
    "waitTime": 0
  }
]
No content

Last updated

Was this helpful?