Skip to main content
Version: v1

Years

Most of the BAV dataset is tied up in one way or another to a year.

List Years​

To list all of the years, use the list endpoint:

GET /api/v1/years

The years list response contains details about the year.

Schema​

KeyTypeDescription
idintegerThe system ID for the year.
yearintegerThe "name" of the year.
{
    "data": [
        {
            "id": 30,
            "year": 2022
        },
        //...
    ]
    // ...
}

Get a Base​

You may also directly retrieve a year's details if you already have its system ID.

GET /api/v1/years/123

Where 123 is the system ID of the year.

Schema​

KeyTypeDescription
idintegerThe system ID for the year.
yearintegerThe "name" of the year.
{
    "data": {
        "id": 30,
        "year": 2022
    },
}

Configurable Fields​

If you only need some of the fields you can optimize the request for a leaner response ( see Configurable Fields for more information). The following fields can be toggled:

  • year

Expansions​

The years resources does not have any expansions.

Filters​

Sorting​

The following fields are sortable:

  • id
  • year