divisions

GET

Returns a JSON representation of all configured Divisions.

Auth. Required:

Yes

Roles Required:

None

Permissions Required:

DIVISION:READ

Response Type:

Array

Request Structure

Table 524 Request Query Parameters

Name

Description

id

Filter for Divisions having this integral, unique identifier

name

Filter for Divisions with this name

orderby

Choose the ordering of the results - must be the name of one of the fields of the objects in the response array

sortOrder

Changes the order of sorting. Either ascending (default or “asc”) or descending (“desc”)

limit

Choose the maximum number of results to return

offset

The number of results to skip before beginning to return results. Must use in conjunction with limit

page

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.

#1276 Request Example
GET /api/5.0/divisions HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

id:

An integral, unique identifier for this Division

lastUpdated:

The date and time at which this Division was last modified, in RFC 3339 format

Changed in version 5.0: Prior to version 5.0 of the API, this field was in Traffic Ops’s Custom Date/Time Format.

name:

The Division name

#1277 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: SLKi9RHa67sGoSz62IDcQsk7KZjTXKfonqMoCUFPXGcNUdhBssvUjc1G7KkWK8X1Ny16geMx2BN8Hm/3dQ75GA==
X-Server-Name: traffic_ops_golang/
Date: Thu, 29 Nov 2018 19:44:03 GMT
Content-Length: 139

{ "response": [
    {
        "id": 1,
        "lastUpdated": "2018-11-29T09:39:09.761097+05:30",
        "name": "Quebec"
    },
    {
        "id": 2,
        "lastUpdated": "2018-11-29T15:29:31.872822+05:30",
        "name": "USA"
    }
]}

POST

Creates a new Division.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

DIVISION:CREATE, DIVISION:READ

Response Type:

Object

Request Structure

name:

The name of the new Division

#1278 Request Example
POST /api/5.0/divisions HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 16
Content-Type: application/json

{"name": "test"}

Response Structure

id:

An integral, unique identifier for this Division

lastUpdated:

The date and time at which this Division was last modified, in RFC 3339 format

Changed in version 5.0: Prior to version 5.0 of the API, this field was in Traffic Ops’s Custom Date/Time Format.

name:

The Division name

#1279 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: +pJm4c3O+JTaSXNt+LP+u240Ba/SsvSSDOQ4rDc6hcyZ0FIL+iY/WWrMHhpLulRGKGY88bM4YPCMaxGn3FZ9yQ==
X-Server-Name: traffic_ops_golang/
Date: Thu, 29 Nov 2018 19:52:06 GMT
Content-Length: 136

{ "alerts": [
    {
        "text": "division was created.",
        "level": "success"
    }
],
"response": {
    "id": 3,
    "lastUpdated": "2018-11-29T19:52:06.872822+05:30",
    "name": "test"
}}