Taxonomy topics

Taxonomies are used to classify works.

Taxonomies are used to categorise and group works. Taxonomies are made up of topics that form a tree structure. Each topic has a unique slug which identifies the topic.

A work may be associated with zero, one or many taxonomy topics.

List taxonomy topics

API endpoint for listing taxonomy topics. Taxonomy topics are a tree structure of topics that are applied to documents to categorise them.

GET/v3/taxonomy-topics

Authorization

cookieAuthtokenAuth

Query parameters

Response

200

Body

application/json

countinteger

Example: 123

nextnullable string

previousnullable string

resultsarray of TaxonomyTopic (object)

Request

JavaScriptCurlPython

const response = await fetch('/v3/taxonomy-topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "name": "text",
      "slug": "text",
      "children": []
    }
  ]
}

Get a taxonomy topic

API endpoint for listing taxonomy topics. Taxonomy topics are a tree structure of topics that are applied to documents to categorise them.

GET/v3/taxonomy-topics/{slug}

Authorization

cookieAuthtokenAuth

Path parameters

slug*string

Unique short name (code) for the topic.

Response

200

Body

application/json

name*string

Name of the taxonomy topic

slug*string

Unique short name (code) for the topic.

Pattern: ^[-a-zA-Z0-9_]+$

id*integer

children*array of TaxonomyTopic (object)

Request

JavaScriptCurlPython

const response = await fetch('/v3/taxonomy-topics/{slug}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "text",
  "slug": "text",
  "children": []
}

List work expressions tagged with a taxonomy topic

List of work expressions for a taxonomy topic.

GET/v3/taxonomy-topics/{slug}/work-expressions

Authorization

cookieAuthtokenAuth

Path parameters

slug*string

Query parameters

Response

200

Body

application/json

countinteger

Example: 123

nextnullable string

previousnullable string

resultsarray of WorkExpression (object)

Request

JavaScriptCurlPython

const response = await fetch('/v3/taxonomy-topics/{slug}/work-expressions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "url": "https://example.com",
      "title": "text",
      "created_at": "2024-11-21T06:21:21.398Z",
      "updated_at": "2024-11-21T06:21:21.398Z",
      "country": "text",
      "locality": "text",
      "nature": "text",
      "subtype": "text",
      "actor": "text",
      "year": "text",
      "number": "text",
      "frbr_uri": "text",
      "expression_frbr_uri": "text",
      "publication_date": "2024-11-21",
      "publication_name": "text",
      "publication_number": "text",
      "publication_document": {
        "url": "https://example.com",
        "filename": "text",
        "mime_type": "text"
      },
      "commenced": false,
      "commenced_in_full": false,
      "commencement_date": "2024-11-21",
      "commencing_work": {
        "frbr_uri": "text",
        "title": "text"
      },
      "assent_date": "2024-11-21",
      "repeal": {
        "date": "2024-11-21",
        "repealing_title": "text",
        "repealing_uri": "text"
      },
      "parent_work": {
        "frbr_uri": "text",
        "title": "text"
      },
      "expression_date": "2024-11-21",
      "language": "text",
      "points_in_time": [
        {
          "date": "2024-11-21",
          "expressions": [
            {
              "url": "https://example.com",
              "language": "text",
              "expression_frbr_uri": "text",
              "expression_date": "2024-11-21",
              "title": "text"
            }
          ]
        }
      ],
      "amendments": [
        {
          "date": "2024-11-21",
          "amending_title": "text",
          "amending_uri": "text"
        }
      ],
      "work_amendments": [
        {
          "date": "2024-11-21",
          "amending_title": "text",
          "amending_uri": "text"
        }
      ],
      "stub": false,
      "principal": false,
      "numbered_title": "text",
      "taxonomy_topics": [
        "text"
      ],
      "as_at_date": "2024-11-21",
      "type_name": "text",
      "amendments_made": "text",
      "enacted_as": "text",
      "repeals_made": "text",
      "commencements_made": "text",
      "links": [
        {
          "rel": "text",
          "title": "text",
          "href": "https://example.com",
          "media_type": "text"
        }
      ],
      "disclaimer": "text",
      "aliases": [
        "text"
      ]
    }
  ]
}