Get work zones

get

/rest/ofscMetadata/v1/workZones

This operation retrieves the list of work zones that are visible to the API user.

Request

Query Parameters
  • The maximum number of items returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
  • The number of items that are skipped in the response. If a value is not specified, then it defaults to zero. The value zero indicates that the retrieval starts from the beginning of the collection.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : workZones
Type: object
The collection of work zones.
Show Source
Nested Schema : items
Type: array
An array of work zone items.
Show Source
Nested Schema : Work Zone
Type: object
Title: Work Zone
Show Source
Nested Schema : Keys
Type: array
Title: Keys
Show Source
Nested Schema : Shapes
Type: array
Title: Shapes
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to return a list of work zones in the system by submitting a GET request on the REST resource using cURL.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscMetadata/v1/workZones/ HTTP/1.0
Authorization: Basic *****
Host: <instance_name>.etadirect.com
Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "hasMore": false,
    "totalResults": 13,
    "limit": 100,
    "offset": 0,
    "items": [
        {
            "workZoneLabel": "ALTAMONTE SPRINGS",
            "workZoneName": "ALTAMONTE SPRINGS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "ALTA"
            ],
            "shapes": [
                "32701",
                "32707",
                "32714",
                "32730",
                "32751"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/ALTAMONTE+SPRINGS"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "CASSELBERRY",
            "workZoneName": "CASSELBERRY",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "CASS"
            ],
            "shapes": [
                "32707"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/CASSELBERRY"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "CHULUOTA",
            "workZoneName": "CHULUOTA",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "CHUL"
            ],
            "shapes": [
                "32766"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/CHULUOTA"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "GENEVA",
            "workZoneName": "GENEVA",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "GENE"
            ],
            "shapes": [
                "32732"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/GENEVA"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "HEATHROW",
            "workZoneName": "HEATHROW",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "HEAT"
            ],
            "shapes": [
                "32746"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/HEATHROW"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "LAKE MARY",
            "workZoneName": "LAKE MARY",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "LAKE"
            ],
            "shapes": [
                "32746"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/LAKE+MARY"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "LONGWOOD",
            "workZoneName": "LONGWOOD",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "LONG"
            ],
            "shapes": [
                "327450"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/LONGWOOD"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "OVIEDO",
            "workZoneName": "OVIEDO",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "OVIE"
            ],
            "shapes": [
                "32765"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/OVIEDO"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "SANFORD",
            "workZoneName": "SANFORD",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "SANF"
            ],
            "shapes": [
                "32771"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/SANFORD"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "WINTER SPRINGS",
            "workZoneName": "WINTER SPRINGS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "WINT"
            ],
            "shapes": [
                "32708"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/WINTER+SPRINGS"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "Port St Lucie",
            "workZoneName": "Port St Lucie",
            "status": "inactive",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "Port"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/Port+St+Lucie"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "TEX",
            "workZoneName": "TEXAS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "ANDR",
                "COLO",
                "KERM",
                "LUBB",
                "MIDL",
                "ODES"
            ],
            "shapes": [
                "79401",
                "79512",
                "79701",
                "79714",
                "79745",
                "79761"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/TEX"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "testWorkZoneLabel",
            "workZoneName": "testWorkZoneLabel",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones/testWorkZoneLabel"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones?limit=100&offset=0"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
        }
    ]
}
Back to Top