API docs by Redocly

traffic-plan (3.x)

Download OpenAPI specification:Download

The traffic plan API is used to browse and download traffic plan exports. The exports are organized by contract-id and version. For each contract there exists one or more exports with unique versions.

Fetch token

Used to fetch an authentication token. The token is needed to identify the client when using the other endpoints in the API. The token is valid for one hour.

Request Body schema: application/x-www-form-urlencoded
grant_type
string
scope
string
client_id
string
client_secret
string

Responses

Response samples

Content type
application/json
{
  • "access_token": "[token]",
  • "expires_in": 3600,
  • "token_type": "Bearer"
}

Fetch contract ids

Used to fetch the id and name of all contracts available to the client.

Authorizations:
client-authorizer

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ]
}

Find latest version

Used to find all versions for a specific contract.

Authorizations:
client-authorizer
path Parameters
contract-id
required
string

The id of the requested operator contract.

Responses

Response samples

Content type
application/json
{
  • "contract": "RUT:OperatorContract:1234",
  • "versions": [
    ]
}

Fetch export url

Used to get the url to an export for a specific contract with a specific version. The url can be used to download the export directly. It is pre-signed and valid for one hour.

Authorizations:
client-authorizer
path Parameters
contract-id
required
string

The id of the requested operator contract.

version-id
required
string

The requested operator contract version.

Responses