Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "plan-AB",
      "agencyId": "LND_Agency-42",
      "version": 42,
      "running": true,
      "status": {
        "planVersionInSolution": 42,
        "waitingRoom": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "waitingTraffic": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "creation": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "optimization": {
          "waitingVersion": 42,
          "runningVersion": 42
        }
      },
      "properties": {}
    }
  ],
  "agencyId": "LND_Agency-42",
  "paging": {
    "total": 142,
    "totalPages": 5,
    "page": 2,
    "nextPage": 3,
    "previousPage": 1,
    "itemsPerPage": 30
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Plan

Retrieves a collection of plans

At the moment, retrieving a collection of plans is not paginated by default. The paging is performed when at least one of the paging query parameters (page or itemsPerPage) is present with a valid value. The default values are used like this:

if page is present and itemsPerPage is absent, the paging is performed with a default value for itemsPerPage,
if itemsPerPage is present and page is absent, the paging is performed with a default value for page,
but if both page and itemsPerPage are absent, no paging is performed.

GET

agencies

{agencyId}

plans

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "plan-AB",
      "agencyId": "LND_Agency-42",
      "version": 42,
      "running": true,
      "status": {
        "planVersionInSolution": 42,
        "waitingRoom": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "waitingTraffic": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "creation": {
          "waitingVersion": 42,
          "runningVersion": 42
        },
        "optimization": {
          "waitingVersion": 42,
          "runningVersion": 42
        }
      },
      "properties": {}
    }
  ],
  "agencyId": "LND_Agency-42",
  "paging": {
    "total": 142,
    "totalPages": 5,
    "page": 2,
    "nextPage": 3,
    "previousPage": 1,
    "itemsPerPage": 30
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agencyId

string

required

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

Query Parameters

page

integer

default:1

The page number of a paginated list of records.

Required range: x >= 1

Example:

1

itemsPerPage

integer

default:20

The number of items per page in a paginated list of records.

Required range: 1 <= x <= 100

Example:

30

archived

enum<string>

default:excluded

Indicates if and how archived items should be part of the result.

Available options:

excluded,

included,

only

Response

Plan collection response in a light representation.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

items

object[]

Show child attributes

agencyId

string

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

paging

object

[TO_VALIDATE] Description pending review by a Kardinal engineer.

Show child attributes

API

Data model

Changes

Retrieves a collection of plans

Authorizations

Path Parameters

Query Parameters

Response