Get Data Holder Statuses V1

This page documents the obsolete version 1 of the Get Data Holder Statuses endpoint.

Get Data Holder Statuses

Code samples

GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/status HTTP/1.1

Accept: application/json
x-v: 1
x-min-v: string
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'1',
  'x-min-v':'string',
  'If-None-Match':'string'

};

fetch('https://<register-base-url>/cdr-register/v1/{industry}/data-holders/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /cdr-register/v1/{industry}/data-holders/status

Endpoint used by participants to discover the statuses for Data Holders from the CDR Register

Endpoint Version

Version	1

Parameters

Name	In	Type	Required	Description
industry	path	string	mandatory	The industry the participant is retrieving data for (Banking, etc)
x-v	header	string	optional	The version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
x-min-v	header	string	optional	The minimum version of the API end point requested by the client. Must be set to a positive integer if provided.
If-None-Match	header	string	optional	Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.

Enumerated Values

Parameter	Value
industry	banking
industry	energy
industry	telco
industry	all

Example responses

200 Response

{
  "data": [
    {
      "legalEntityId": "string",
      "status": "ACTIVE"
    }
  ],
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	DataHoldersStatusList
304	Not Modified	Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header	None
400	Bad Request	Missing Required Header / Invalid Version / Invalid Path Parameter	ResponseErrorListV2
406	Not Acceptable	Unsupported Version	ResponseErrorListV2

Response Headers

Status	Header	Type	Format	Description
200	x-v	string		The version of the API end point that the CDR Register has responded with.
200	Etag	string		Entity tag that uniquely represents the requested resource.
304	Etag	string		Entity tag that uniquely represents the requested resource.

Schemas

DataHoldersStatusList

{
  "data": [
    {
      "legalEntityId": "string",
      "status": "ACTIVE"
    }
  ],
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	[DataHolderStatus]	mandatory	Response data for the query
links	Links	mandatory	none
meta	Meta	mandatory	none

DataHolderStatus

{
  "legalEntityId": "string",
  "status": "ACTIVE"
}

Properties

Name	Type	Required	Description
legalEntityId	string	mandatory	Unique id of the Data Holder Legal Entity issued by the CDR Register.
status	Enum	mandatory	Data Holder status in the CDR Register

Enumerated Values

Property	Value
status	ACTIVE
status	REMOVED

Links

{
  "self": "string"
}

Properties

Name	Type	Required	Description
self	URIString	mandatory	Fully qualified link to this API call

Meta

{}

Properties

None

MetaError

{
  "urn": "string"
}

Additional data for customised error codes

Properties

Name	Type	Required	Description
urn	string	conditional	The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Description
errors	[ResponseErrorListV2_errors]	mandatory	none

ResponseErrorListV2_errors

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {
    "urn": "string"
  }
}

Properties

Name	Type	Required	Description
code	string	mandatory	The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
title	string	mandatory	A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail	string	mandatory	A human-readable explanation specific to this occurrence of the problem.
meta	MetaError	optional	Additional data for customised error codes