Get a work zone
get
/rest/ofscMetadata/v1/workZones/{label}
This operation retrieves the attributes of the specified work zone.
Request
Path Parameters
-
label(required): string
Minimum Length:
1
Maximum Length:255
The label of the work zone.
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Work Zone
Type:
object
Title:
Show Source
Work Zone
-
keys:
array Keys
Title:
Keys
-
organization:
string
Title:
The organization label
Minimum Length:1
Maximum Length:255
-
shapes:
array Shapes
Title:
Shapes
-
status:
string
Title:
Status
Allowed Values:[ "active", "inactive" ]
-
travelArea(required):
string
Title:
Travel Area
Allowed Values:[ "sunrise_enterprise", "New" ]
-
workZoneLabel(required):
string
Title:
Work Zone Label
Minimum Length:1
Maximum Length:255
-
workZoneName(required):
string
Title:
Work Zone Name
Minimum Length:1
Maximum Length:255
Nested Schema : Keys
Type:
array
Title:
Show Source
Keys
-
Array of:
string
Minimum Length:
1
Maximum Length:50
Nested Schema : Shapes
Type:
array
Title:
Show Source
Shapes
-
Array of:
string
Minimum Length:
1
Maximum Length:50
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.
Examples
The following example shows how to get a specific work zone by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET /rest/ofscMetadata/v1/workZones/ROB_DAS
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "status":"active", "workZoneLabel":"ROB_DAS", "workZoneName": "ROB_DAS", "travelArea":"label", "keys":["KHRK","LVIV"], "shapes":["REG11","REG3","REG13"] }