Single work expression

Fetch a single work expression using an FRBR URI.

PreviousAll work expressions NextCommencements

Last updated 10 months ago

Single work expression

Fetch a single work expression using an FRBR URI.

Fetch a single work expression

Supported content types: JSON, HTML, PDF, ePub, zip.

Query Parameters for HTML Content

When fetching HTML content (using the .html endpoint), you can control some aspects of how the HTML is generated using query parameters.

For example, usually you will want to make links to other legislation relative to your website. You can do this by using ?resolver=none when fetching the HTML.

Name

Type

Description

coverpage

string

Should the response include a generated coverpage? Use 1 for true, anything else for false. Default: 1. HTML-only.

media-url

string

The fully-qualified URL prefix to use when generating links to embedded media, such as images.

resolver

string

The fully-qualified URL to use when resolving references to other Akoma Ntoso documents. Use no or none to disable. Defaults to using the Laws.Africa resolver.

standalone

number

If this is 1 , the response will be a complete HTML document, including CSS, that can stand on its own. Otherwise it will be an HTML fragment. Default: false. HTML-only.

Expressions at specific points in time

Works may be amended and change over time. You can fetch different amended versions of a work by specifying the language and date in the FRBR URI of the request.

The available points in time of a work are listed in the points_in_time field of the JSON description of the work. Each point in time includes a date and a list of expressions available at that date, one for each available language.

To fetch the very first expression of a work, use frbr-uri/:language@, for example: /akn/za/act/1998/5/eng@.

To fetch a specific point in time, use frbr-uri/:language@:date, for example: /akn/za/act/1998/5/eng@2014-01-17.

To fetch the most recent point in time at or before a specific date, use frbr-uri/:language::date, for example /akn/za/act/1998/5/eng:2014-01-17.

The .format part of the FRBR URI is placed after the @YYYY-MM-DD part.

If you use @ to specify a particular date and the API doesn't have a version at exactly that date, it will return a 404 response. If you need the expression of the work closest to a particular date, use : instead.

Date formats for specific points in time

Date Format

Meaning

Example Expression FRBR URI

@

Very first expression of a work.

/akn/za/act/1998/55/eng@

@YYYY-MM-DD

Expression at the specific date.

/akn/za/act/1998/55/eng@2014-01-17

:YYYY-MM-DD

Most recent expression at or before a date.

/akn/za/act/1998/55/eng:2015-01-01

(none)

The most recent expression at or before today's date. Equivalent to using : with today's date.

/akn/za/act/1998/55/eng

PreviousAll work expressions NextCommencements

Last updated 10 months ago

Fetch a single work expression

Supported content types: JSON, HTML, PDF, ePub, zip.

Query Parameters for HTML Content

When fetching HTML content (using the .html endpoint), you can control some aspects of how the HTML is generated using query parameters.

For example, usually you will want to make links to other legislation relative to your website. You can do this by using ?resolver=none when fetching the HTML.

Name

Type

Description

coverpage

string

Should the response include a generated coverpage? Use 1 for true, anything else for false. Default: 1. HTML-only.

media-url

string

The fully-qualified URL prefix to use when generating links to embedded media, such as images.

resolver

string

The fully-qualified URL to use when resolving references to other Akoma Ntoso documents. Use no or none to disable. Defaults to using the Laws.Africa resolver.

standalone

number

If this is 1 , the response will be a complete HTML document, including CSS, that can stand on its own. Otherwise it will be an HTML fragment. Default: false. HTML-only.

Expressions at specific points in time

Works may be amended and change over time. You can fetch different amended versions of a work by specifying the language and date in the FRBR URI of the request.

To fetch the very first expression of a work, use frbr-uri/:language@, for example: /akn/za/act/1998/5/eng@.

To fetch a specific point in time, use frbr-uri/:language@:date, for example: /akn/za/act/1998/5/eng@2014-01-17.

To fetch the most recent point in time at or before a specific date, use frbr-uri/:language::date, for example /akn/za/act/1998/5/eng:2014-01-17.

The .format part of the FRBR URI is placed after the @YYYY-MM-DD part.

Date formats for specific points in time

Date Format

Meaning

Example Expression FRBR URI

@

Very first expression of a work.

/akn/za/act/1998/55/eng@

@YYYY-MM-DD

Expression at the specific date.

/akn/za/act/1998/55/eng@2014-01-17

:YYYY-MM-DD

Most recent expression at or before a date.

/akn/za/act/1998/55/eng:2015-01-01

(none)

The most recent expression at or before today's date. Equivalent to using : with today's date.

/akn/za/act/1998/55/eng

get

GET /v3/{frbr_uri} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "url": "https://example.com",
  "title": "text",
  "created_at": "2025-04-24T16:28:51.796Z",
  "updated_at": "2025-04-24T16:28:51.796Z",
  "country": "text",
  "locality": "text",
  "nature": "text",
  "subtype": "text",
  "actor": "text",
  "year": "text",
  "number": "text",
  "frbr_uri": "text",
  "expression_frbr_uri": "text",
  "publication_date": "2025-04-24",
  "publication_name": "text",
  "publication_number": "text",
  "publication_document": {
    "url": "https://example.com",
    "filename": "text",
    "mime_type": "text",
    "size": 1
  },
  "commenced": true,
  "commenced_in_full": true,
  "commencement_date": "2025-04-24",
  "commencing_work": {
    "frbr_uri": "text",
    "title": "text"
  },
  "assent_date": "2025-04-24",
  "repeal": {
    "date": "2025-04-24",
    "repealing_title": "text",
    "repealing_uri": "text"
  },
  "parent_work": {
    "frbr_uri": "text",
    "title": "text"
  },
  "expression_date": "2025-04-24",
  "language": "text",
  "points_in_time": [
    {
      "date": "2025-04-24",
      "expressions": [
        {
          "url": "https://example.com",
          "language": "text",
          "expression_frbr_uri": "text",
          "expression_date": "2025-04-24",
          "title": "text"
        }
      ]
    }
  ],
  "amendments": [
    {
      "date": "2025-04-24",
      "amending_title": "text",
      "amending_uri": "text"
    }
  ],
  "work_amendments": [
    {
      "date": "2025-04-24",
      "amending_title": "text",
      "amending_uri": "text"
    }
  ],
  "stub": true,
  "principal": true,
  "numbered_title": "text",
  "taxonomy_topics": [
    "text"
  ],
  "as_at_date": "2025-04-24",
  "custom_properties": null,
  "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"
  ]
}

Fetch a single work expression

Query Parameters for HTML Content

Expressions at specific points in time

Date formats for specific points in time

Fetch a single work expression

Query Parameters for HTML Content

Expressions at specific points in time

Date formats for specific points in time

Retrieve a work expression by FRBR URI.