NEnextbillion-ai
Map-Data_Road-Editor

Set the state of a restriction by ID

Changed on
put/restrictions/{id}/state

Request

Path parameters

idinteger required

Unique ID of the restriction. This is the ID that was generated at the time of creating the restriction.

Query parameters

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.

Request body

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

Use this field to specify the new state of the restriction. Please note that this method cannot update the state of restrictions that are currently in 'deleted' state.

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 deleted of the request property

    • breaking

      removed the enum value disabled of the request property

    • breaking

      removed the enum value enabled of the request property

    • info

      added the new deleted enum value to the request property

    • info

      added the new disabled enum value to the request property

    • info

      added the new enabled enum value to the request property

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value deleted of the request property

    • breaking

      removed the enum value disabled of the request property

    • breaking

      removed the enum value enabled of the request property

    • info

      added the new deleted enum value to the request property

    • info

      added the new disabled enum value to the request property

    • info

      added the new enabled enum value to the request property