This is in beta. If you find something wrong, let us know

Definitions Catalogue

Getting Started

Collaborate

Using the API

Search

Browse

Details

Domains

Posting

Paths

Schema

Details

The details of a definition can be found at this URL:

https://api.gov.au/definitions/api/definition/{domain}/{id}

The domain URL parameter specifies a domain the definition is in.

More information about domains, and the values the parameter takes is here.

The id URL parameter specifies the unique id, within a domain, for the definition.

The results of the details service look like this:

{
  "content": {
    "name": "Electronic Contact Facsimile Area Code",
    "domain": "Other",
    "status": "Standard",
    "definition": "This element describes a standard Australian Area Code as used in conjunction with facsimile numbers.",
    "guidance": "",
    "identifier": "https://api.ausdx.io/definition/otherde10",
    "usage": [
      "Australian Taxation Office",
      "NSW Office of Revenue",
      "SA Office of Revenue",
      "VIC Office of Revenue"
    ],
    "type": "string",
    "values": [

    ],
    "facets": {
      "pattern": "[0-9]{2}"
    }
  },
  "links": [
    {
      "rel": "syntax",
      "href": "http://api.gov.au/definitions/api/syntax/other/de10"
    }
  ]
}

Finding ids

Each result from the search or browse serviecs includes all the details of a definition.

If you want to call the detail service anyway, you can use the definition's identifier field.

This URL is for the web version - if you want the API version, insert /api before /definition/ (eg: http://api.gov.au/definitions/api/definition/other/de10):

eg:

"content": {
        "name": "Electronic Contact Facsimile Area Code",
        "domain": "Other",
        "status": "Standard",
        "definition": "This element describes a standard Australian Area Code as used in conjunction with facsimile numbers.",
        "guidance": "",

       --->  "identifier": "http://api.gov.au/definition/other/de10",

        "usage": [
          "Australian Taxation Office",
          "NSW Office of Revenue",
          "SA Office of Revenue",
          "VIC Office of Revenue"
        ],
        "type": "string",
        "values": [

        ],
        "facets": {
          "pattern": "[0-9]{2}"
        }
      },
      "links": [
        {
          "rel": "syntax",
          "href": "http://api.gov.au/definitions/api/syntax/other/de10"
        }
      ]
    }

Syntax specific metadata

Some definitions have metadata for specific technologies.

The metadata service is at this URL:

https://api.gov.au/definitions/api/syntax/{domain}/{id}

The syntax URL for every definition is included in the HATEOS links in the search, browse and detail services.

The results from the syntax service look like:

{
  "syntaxes": {
    "xbrl": {
      "period": "duration",
      "classification": "py/pyde/pyde.02.00"
    }
  }
}

The fields will vary based on the syntax, but we believe they will always be key:value pairs.



Last edited: 25 Feb 2020, 15:43:44