Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Map-Data_Road-Editor

Get the paginated list of restrictions

get/restrictions/list

Query parameters

transformboolean

a internal parameter

source'rrt' | 'pbf'

It represents where it comes from, currently the possible values include "rrt", "xsm"

restriction_type'turn' | 'parking' | 'fixedspeed' | 'maxspeed' | 'closure' | 'truck'

Specify the type of restrictions to fetch.

status'active' | 'inactive'
Example:status=inactive

Restrictions can be active or inactive at a given time by virtue of their nature. For example, maximum speed limits can be active on the roads leading to schools during school hours and be inactive afterwards or certain road closure restrictions be active during holidays/concerts and be inactive otherwise.

Use this parameter to filter the restrictions based on their status at the time of making the request i.e. whether they are in force or not.

state'enabled' | 'disabled' | 'deleted'
Example:state=deleted

This parameter is used to filter restrictions based on their state i.e. whether the restriction is currently enabled, disabled, or deleted. For example, users can retrieve a list of all the deleted restrictions by setting state=deleted.

mode'0w' | '2w' | '3w' | '4w' | '6w'

Specify the modes of travel that the restriction pertains to.

areastring required

Specify the area name. It represents a region where restrictions can be applied.

The area it belongs to. See Area API

namestring

The name of the restriction. This should be same as that provided while creating or updating the restriction.

limitinteger required

The number of restrictions to be returned in the response. Please note that if the limit is set to a number more than the total number of available restrictions, then all restrictions would be returned together.

offsetinteger required

An integer value indicating the number of items in the collection that need to be skipped in the response. Please note that the offset starts from 0, so the first item returned in the result would be the item at (offset + 1) position in collection.

Users can use offset along with limit to implement paginated result.

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Response

Example response

{
  "data": [
    {
      "bbox": {
        "minLat": 0,
        "minLon": 0,
        "maxLat": 1,
        "maxLon": 1
      },
      "repeat_on": "Mo-Fr 07:00-09:00,17:00-19:00"
    }
  ]
}