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

Search

The search service is available at this URL

https://api.gov.au/definitions/api/search

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

The query query parameter specifies the query to search on.

The domain query parameter specifies a domain to restrict the search to. If you don't provide a value for domain, the definitons from all domains will be searched.

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

The response from the search, including the HATEOS wrapper, service looks like this:

http://api.gov.au/definitions/api/search?query=de10

{
  "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": 1,
  "firstPage": true,
  "lastPage": true,
  "totalPages": 1,
  "links": [
    {
      "rel": "first",
      "href": "http://api.gov.au/definitions/api/search?query=de10&page=1&size=20"
    },
    {
      "rel": "last",
      "href": "http://api.gov.au/definitions/api/search?query=de10&page=1&size=20"
    },
    {
      "rel": "self",
      "href": "http://api.gov.au/definitions/api/search?query=de10&page=1&size=20"
    }
  ],
  "id": {
    "rel": "self",
    "href": "http://api.gov.au/definitions/api/search?query=de10&page=1&size=20"
  }
}

Examples

Here is an example call that searches for the words 'motor vehicle' in all domains:

http://api.gov.au/definitions/api/search?query=motor+vehicle

And and example speficying a domain:

http://api.gov.au/definitions/api/search?query=motor+vehicle&domain=fs

And an example with paging:

http://api.gov.au/definitions/api/search?query=motor+vehicle&domain=fs&page=1&size=20

Synonyms

We will include any results that have synonyms from your search query.

We want to make the synonym list better, so contact us if you have updates.



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