Page Comparison

...

Issue

Description

The Token Endpoint is not included in the Consumer Data Standards

Whilst the Register’s Token Endpoint is discoverable from the Get OpenId Provider Config endpoint, it has been included here (https://cdr-internal.atlassian.net/l/cp/5j6FBnnr)Token Endpointfor completeness and for consistency with the Security Profile for Data Holders.

Endpoints return ‘503 service not avail’ when industry is empty

For e.g.

A request to https://api.cdr.gov.au/cdr-register/v1//data-recipients will return:

Code Block

HTTP/1.1 503 
Content-Type: text/html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN""http://www.w3.org/TR/html4/strict.dtd">
<HTML><HEAD><TITLE>Service Unavailable</TITLE>
<META HTTP-EQUIV="Content-Type" Content="text/html; charset=us-ascii"></HEAD>
<BODY><h2>Service Unavailable</h2>
<hr><p>HTTP Error 503. The service is unavailable.</p>
</BODY></HTML>

The Consumer Data Standards define competing responses for Register API errors

The CDR Register Errors section outlines errors that MAY be returned from the CDR Register APIs.

Individual Register API definitions (e.g. Get Data Recipients) also outline the errors that can be returned from the API.

These error definitions are currently not aligned.

In the case that an invalid industry path parameter is provided, the Register APIs will respond differently depending on the version of the API requested.

Current versions will return a 400 Invalid Industry error whilst deprecated versions will return a 404 Not Found error.

For e.g.

Current Endpoint Version

Code Block

# Request
GET /cdr-register/v1/invalid/data-recipients
x-v: 3

# Response
HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "errors": [
        {
            "code": "urn:au-cds:error:cds-all:Field/Invalid",
            "title": "Invalid Field",
            "detail": "Invalid Path Parameter"
        }
    ]
}

Obsolete Endpoint Version

Code Block

# Request
GET /cdr-register/v1/invalid/data-recipients
x-v: 2

# Response
HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "errors": [
        {
            "code": "urn:au-cds:error:cds-register:Field/InvalidIndustry",
            "title": "Invalid Industry",
            "detail": "Industry URL parameter is invalid"
        }
    ]
}

...

Versions Compared

Old Version 2

New Version 3

Key