NEnextbillion-ai
Map-Data_Road-Editor

Get restrictions by bbox

Changed on
get/restrictions

Request

Query parameters

min_latnumber required

Specifies the minimum latitude value for the bounding box.

min_lonnumber required

Specifies the minimum longitude value for the bounding box.

max_latnumber required

Specifies the maximum latitude value for the bounding box.

max_lonnumber required

Specifies the maximum longitude value for the bounding box.

transformboolean

This is internal parameter with a default value as false.

source'rrt' | 'pbf'

This parameter represents where the restriction comes from and cannot be modified by clients sending requests to the API endpoint.

For example, an API endpoint that returns a list of restrictions could include the source parameter to indicate where each item comes from. This parameter can be useful for filtering, sorting, or grouping the results based on their source.

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.

modestring[]

Specify the modes of travel that the restriction pertains to.

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

idinteger

Returns the unique ID of the restriction. This ID can be used for update, delete, get operations on the restriction using the available API methods.

namestring

Returns the name of the restriction. This value is same as that provided at the time of creating or updating the restriction.

areastring

Returns the area to which the restriction belongs to.

bboxobject

Returns the details of the bounding box containing the restriction.

status'active' | 'inactive'

Returns the status of the restriction at the time of making the request i.e. whether the restriction is in force or not. It will have one of the following values: active or inactive.

Please note that this field can not be directly influenced by the users. It will always be calculated using the start_time, end_time and repeat_on parameters.

repeat_onstring

Returns the time periods during which this restriction active or repeats on. The time values follow a given format.

commentstring

Returns the comments that were provided for the restriction at the time of creating or updating the request.

create_atstring date-time

The timestamp at which the restriction was created.

update_atstring date-time

The timestamp at which the restriction was updated.

start_timenumber

The time when the restriction starts to be in-effect. It is a UNIX timestamp.

end_timenumber

The time when the restriction ceases to be in-effect. It is a UNIX timestamp.

modestring[]

Returns an array denoting all the traveling modes the restriction applies on.

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

Returns the type of restriction. This is the same value as provided when creating or updating the restriction.

highwaystring

Returns the highway information on which the restriction applies to. If no highway is impacted by the restriction, then this field is not present in the response.

speednumber

Returns the fixed speed of segments. This field is not present in the response if the restriction type is not fixedspeed

speed_limitnumber

Returns the maximum speed of segments. This field is not present in the response if the restriction type is not maxspeed

direction'forward' | 'backward' | 'both'

Returns the direction of travel on the segments to which the restriction applies.

state'enabled' | 'disabled' | 'deleted'

Returns the state of the "restriction" itself - enabled, disabled or deleted. It does not denote if the restriction is actually in effect or not.

geofenceobject

Returns the list of coordinates representing the area that was used to apply the given restriction. The geofence returned is same as that provided while creating or updating the restriction.

Example response

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

Changes

  • 7ee76f0ff679Revision changes
    • breaking

      removed the enum value active from the query request parameter status

    • breaking

      removed the enum value deleted from the query request parameter state

    • breaking

      removed the enum value disabled from the query request parameter state

    • breaking

      removed the enum value enabled from the query request parameter state

    • breaking

      removed the enum value inactive from the query request parameter status

    • info

      added the new enum value active to the query request parameter status

    • info

      added the new enum value deleted to the query request parameter state

    • info

      added the new enum value disabled to the query request parameter state

    • info

      added the new enum value enabled to the query request parameter state

    • info

      added the new enum value inactive to the query request parameter status

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value active from the query request parameter status

    • breaking

      removed the enum value deleted from the query request parameter state

    • breaking

      removed the enum value disabled from the query request parameter state

    • breaking

      removed the enum value enabled from the query request parameter state

    • breaking

      removed the enum value inactive from the query request parameter status

    • info

      added the new enum value active to the query request parameter status

    • info

      added the new enum value deleted to the query request parameter state

    • info

      added the new enum value disabled to the query request parameter state

    • info

      added the new enum value enabled to the query request parameter state

    • info

      added the new enum value inactive to the query request parameter status