Single work expression

Fetch a single work expression using an FRBR URI.

Fetch a single work expression

Retrieve a work expression by FRBR URI.

Get details of a work expression (or a partion of one) using either a work or expression FRBR URI.

• /akn/za/act/1994/2.json: Act 2 of 1992 in JSON format.
• /akn/za/act/1994/2/[e-mail]: Act 2 of 1992, English version at 1994-01-01, in JSON format.

GET/v3/{frbr_uri}

Authorization

cookieAuthtokenAuth

Path parameters

frbr_uri*string

The FRBR URI of the work or work expression, without the first slash, such as akn/za/act/1994/2/

Query parameters

Response

200

Body

application/jsonapplication/xmltext/htmlapplication/zipapplication/pdfapplication/epub+zip

url*string (uri)

Detail URL for this work expression.

titlestring

Short title of the work, in the expression language.

created_at*string (date-time)

Timestamp of when the expression was first created.

updated_at*string (date-time)

Timestamp of when the expression was last updated.

countrystring

ISO 3166-1 alpha-2 country code that this work belongs to.

localitystring

The code of the locality within the country.

nature*string

Doctype component of the work FRBR URI.

subtypestring

Subtype component of the work FRBR URI.

actorstring

Actor component of the work FRBR URI.

year*string

Year portion of the FRBR date component the work FRBR URI.

number*string

Number component of the work FRBR URI.

frbr_uri*string

FRBR URI that uniquely identifies this work.

expression_frbr_uri*string

FRBR URI that uniquely identifies this work expression.

publication_date*string (date)

Date of original publication of the work.

publication_name*string

Name of the publication in which the work was originally published.

publication_number*string

Number of the publication in which the work was originally published.

publication_document*all of

Details of the original publication document file for this work.

commenced*boolean

Whether this work has commenced.

commenced_in_full*boolean

Do all the provisions at the curernt expression date have a related commencement?

commencement_date*string (date)

Date on which the bulk of the work commences.

commencing_work*all of

Work that provides the commencement date for the principal work

assent_date*string (date)

Date when the work was assented to.

repeal*all of

Description of the repeal of this work, if it has been repealed.

parent_work*all of

Details of the parent work, for subsidiary works.

expression_date*string (date)

Date of publication or latest amendment

language*string

Three letter ISO-639-2 language code for this work expression.

points_in_time*array of PointInTime (object)

Available historical versions of this work.

amendments*array of Amendment (object)

List of amendments that have been applied to create this expression of the work.

work_amendments*array of Amendment (object)

Details of all amendments to this work.

stub*boolean

A stub work has no content, only metadata.

principal*boolean

A principal work is a main work and not just a repealing, commencing or amending work.

numbered_title*string

Alternative title for the work, using the document type and number.

taxonomy_topics*array of string

Slugs of the taxonomy topics applicable to this work.

as_at_date*string (date)

The date at which this work is known to be up-to-date.

custom_properties*any

type_name*string

Human-friendly version of doctype and/or subtype.

amendments_made*string

enacted_as*string

repeals_made*string

commencements_made*string

links*array of Link (object)

A list of alternate links for this document.

disclaimer*string

Disclaimer text about this work

aliases*array of string

Well-known alternative names for this work.

Request

JavaScriptCurlPython

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

Response

200

{
  "url": "https://example.com",
  "title": "text",
  "created_at": "2024-11-21T06:48:30.567Z",
  "updated_at": "2024-11-21T06:48:30.567Z",
  "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"
  ]
}

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