Definition of 'status' and how health check status can be determined?

Question

The Get Status API specification states that "Obtain a health check status for the implementation".

What is the definition of 'status' and how health check status will be determined?

As a Data Holder we have an implementation spanning across multiple integrations and components to meet the Consumer Data Right requirement. To determine status, do we need to check only the availability of the API endpoints or check the health of other integration components. For example, if all the API endpoints are up and running but the consent management component is not functional, what should be the expected status of the implementation?

Answer

The "status" is the state of the CDR implementation including all APIs and Information Security components. In other words, if you cannot successfully fulfil authorisation requests, consent withdrawal or respond to one or more of the API endpoints, then the status should represent the current availability.

In this case, if one API endpoint is down, it should be a PARTIAL_FAILURE. If all of the CDR implementation is down it would be UNAVAILABLE. Similarly, if there is a planned outage (as reported through Get Outages) then this would be considered SCHEDULED_OUTAGE.

How you determine the status for your implementation will depend on your architecture choices and infrastructure. To what extent you test functionality and integrate into your existing Incident Management solutions is Data Holder dependent. The Data Standards Body doesn't comment on the internal implementation decisions of Data Holders.

See

• Consumer Data Standards - GET Status API