Routing

Replaces WaitTime, Restrictions and OnewayDirection on one or more route elements

Changed on

All three fields are replaced on every element in the body. A field that is left out or null is cleared. For example, a body with only id and waitTime removes the element's restrictions and oneway direction. The other fields of the element are kept, and datasetId, externalId and geometry in the body are ignored.

To change one field, read the element with GET /{apiKey}/api/routing/routeelements?graphId={graphId}, change only that field, and send the whole element back. GET /{apiKey}/api/routing/graphs lists the graph ids.

To open an element, send "restrictions": [].

Oauth2 Roles

  • Requires user to have one of the following roles: admin, editor, owner, service
put/{apiKey}/api/routing/routeelements

Request

  • Base URL
    https://integration.mapsindoors.com (the document declares no server; this is the origin it was published from)
  • URL
    https://integration.mapsindoors.com/{apiKey}/api/routing/routeelements
  • Auth
    OAuth 2
    Authorization code: https://auth.mapsindoors.com/connect/authorize
    Token URL: https://auth.mapsindoors.com/connect/token scopes: integration

Path parameters

apiKeystring required

The API Key to use

Request body

idstring nullable

Id of the route element.

datasetIdstring nullable

Id of the solution the element belongs to.

externalIdstring nullable

External id of the element.

restrictionsstring[] nullable

Tokens needed to pass the element: "locked" closes it for everyone, app user role ids let only those roles pass. Null or [] means open.

onewayDirectionnumber double nullable

Absolute bearing from 0 to 360 degrees. Users may only pass in this direction (+/- 90 degrees), and 0 means north. Null means both directions.

waitTimeinteger nullable

Extra time in seconds that users wait at the element. Must not be negative.

Response

OK

Changes

    • info

      the security scope integration was added to the endpoint's security scheme account

    • info

      the security scope account was removed from the endpoint's security scheme account

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status