regions

GET

Retrieves information about Regions

Auth. Required:

Yes

Roles Required:

None

Permissions Required:

REGION:READ

Response Type:

Object

Request Structure

Table 389 Request Query Parameters

Name	Required	Description
division	no	Filter Regions by the integral, unique identifier of the Division which contains them
id	no	Filter Regions by integral, unique identifier
name	no	Filter Regions by name
orderby	no	Choose the ordering of the results - must be the name of one of the fields of the objects in the response array
sortOrder	no	Changes the order of sorting. Either ascending (default or “asc”) or descending (“desc”)
limit	no	Choose the maximum number of results to return
offset	no	The number of results to skip before beginning to return results. Must use in conjunction with limit
page	no	Return the nth page of results, where “n” is the value of this parameter, pages are limit long and the first page is 1. If offset was defined, this query parameter has no effect. limit must be defined to make use of page.

#941 Request Example

GET /api/4.0/regions?division=1 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

divisionName:

The name of the division which contains this region

divisionId:

The integral, unique identifier of the division which contains this region

id:

An integral, unique identifier for this region

lastUpdated:

The date and time at which this region was last updated, in Traffic Ops’s Custom Date/Time Format

name:

The region name

#942 Response Example

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: nSYbR+fRXaxhYl7dWgf0Udo2AsiXEnwvED1CPbk7ZNWK03I3TOhtmCQx9ABnJJ6xKYnlt6EKMeopVTK0nKU+SQ==
X-Server-Name: traffic_ops_golang/
Date: Thu, 06 Dec 2018 01:58:38 GMT
Content-Length: 117

{ "response": [
    {
        "divisionName": "Quebec",
        "division": 1,
        "id": 2,
        "lastUpdated": "2018-12-05 17:50:58+00",
        "name": "Montreal"
    }
]}

POST

Creates a new region

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

REGION:CREATE, REGION:READ

Response Type:

Object

Request Structure

division:

The integral, unique identifier of the division which shall contain the new region[1]

divisionName:

The name of the division which shall contain the new region[1]

name:

The name of the region

#943 Request Example

POST /api/4.0/regions HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 65
Content-Type: application/json

{
    "name": "Manchester",
    "division": "4",
    "divisionName": "England"
}

[1] (1,2)

The only “division” key that actually matters in the request body is division; divisionName is not validated and has no effect - particularly not the effect of re-naming the division - beyond changing the name in the API response to this request. Subsequent requests will reveal the true name of the division. Note that if divisionName is not present in the request body it will be null in the response, but again further requests will show the true division name (provided it has been assigned to a division).

Response Structure

divisionName:

The name of the division which contains this region

divisionId:

The integral, unique identifier of the division which contains this region

id:

An integral, unique identifier for this region

lastUpdated:

The date and time at which this region was last updated, in Traffic Ops’s Custom Date/Time Format

name:

The region name

#944 Response Example

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: ezxk+iP7o7KE7zpWmGc0j8nz5k+1wAzY0HiNiA2xswTQrt+N+6CgQqUV2r9G1HAsPNr0HF2PhYs/Xr7DrYOw0A==
X-Server-Name: traffic_ops_golang/
Date: Thu, 06 Dec 2018 02:14:45 GMT
Content-Length: 178

{ "alerts": [
    {
        "text": "region was created.",
        "level": "success"
    }
],
"response": {
    "divisionName": "England",
    "division": 3,
    "id": 5,
    "lastUpdated": "2018-12-06 02:14:45+00",
    "name": "Manchester"
}}

DELETE

Deletes a region. If no query parameter is specified, a 400 Bad Request response is returned.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

REGION:DELETE

Response Type:

Object

Request Structure

Table 390 Request Query Parameters

Name	Required	Description
id	no	Delete Region by integral, unique identifier
name	no	Delete Region by name

#945 Request Example

DELETE /api/4.0/regions?name=Manchester HTTP/1.1
User-Agent: curl/7.29.0
Host: trafficops.infra.ciab.test
Accept: */*
Cookie: mojolicious=...

Response Structure

#946 Response Example

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Fri, 07 Feb 2020 13:56:24 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: yNqXKcoiohEbJrEkH8LD1zifh87dIusuvUqgQnYueyKqCXkfd5bQvQ0OhQ2AAdSZa/oe2SAqMjojGsUlxHtIQw==
X-Server-Name: traffic_ops_golang/
Date: Fri, 07 Feb 2020 12:56:24 GMT
Content-Length: 62

{
    "alerts": [
        {
            "text": "region was deleted.",
            "level": "success"
        }
    ]
}