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

Browse

The base URL for the browse service is:

http://api.gov.au/definitions/api/browse

In addition to the paging parameters, search uses the following:

The domain query parameter specifies a domain to browse within.

If you don't provide a value for domain, the definitons from all domains will be browsed.

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

Examples

Here is an example result from the browse service, including the HATEOS wrapper:

http://api.gov.au/definitions/api/browse?domain=fi&page=1&size=1

{
  "content": [
    {
      "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"
        }
      ]
    }
  ],
  "numberOfElements": 6338,
  "firstPage": true,
  "lastPage": false,
  "totalPages": 6338,
  "links": [
    {
      "rel": "first",
      "href": "http://api.gov.au/definitions/api/definitions?domain=fi&page=1&size=1"
    },
    {
      "rel": "last",
      "href": "http://api.gov.au/definitions/api/definitions?domain=fi&page=6338&size=1"
    },
    {
      "rel": "self",
      "href": "http://api.gov.au/definitions/api/definitions?domain=fi&page=1&size=1"
    },
    {
      "rel": "next",
      "href": "http://api.gov.au/definitions/api/definitions?domain=fi&page=2&size=1"
    }
  ],
  "id": {
    "rel": "self",
    "href": "http://api.gov.au/definitions/api/definitions?domain=fi&page=1&size=1"
  }
}


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