NAV Navbar

Get Data Recipient Statuses V1

This page documents the obsolete version 1 of the Get Data Recipient Statuses end point.

Get Data Recipient Statuses

Code samples

GET https://<register-base-url>/cdr-register/v1/{industry}/data-recipients/status HTTP/1.1
Host: <register-base-url>
Accept: application/json
x-v: string

var headers = {
  'Accept':'application/json',
  'x-v':'string'

};

$.ajax({
  url: 'https://<register-base-url>/cdr-register/v1/{industry}/data-recipients/status',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

GET /{industry}/data-recipients/status

Endpoint used by participants to discover the statuses for Data Recipients 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.

Enumerated Values

Parameter Value
industry banking

Example responses

200 Response

{
  "dataRecipients": [
    {
      "dataRecipientId": "string",
      "dataRecipientStatus": "ACTIVE"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success DataRecipientsStatusList
400 Bad Request Bad Request
Invalid industry path parameter
ResponseErrorList
406 Not Acceptable Invalid x-v header
Invalid Accept header
None

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.

DataRecipientsStatusList

{
  "dataRecipients": [
    {
      "dataRecipientId": "string",
      "dataRecipientStatus": "ACTIVE"
    }
  ]
}

Properties

Name Type Required Description
dataRecipients [DataRecipientStatus] mandatory none

DataRecipientStatus

{
  "dataRecipientId": "string",
  "dataRecipientStatus": "ACTIVE"
}

Properties

Name Type Required Description
dataRecipientId string mandatory Unique id of the Data Recipient issued by the CDR Register
dataRecipientStatus string mandatory Data Recipient status in the CDR Register

Enumerated Values

Property Value
dataRecipientStatus ACTIVE
dataRecipientStatus SUSPENDED
dataRecipientStatus REVOKED
dataRecipientStatus SURRENDERED

ResponseErrorList

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

Properties

Name Type Required Description
errors [Error] mandatory none

Error

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

Properties

Name Type Required Description
code string mandatory Error code
title string mandatory Error title
detail string mandatory Error detail
meta object optional Optional additional data for specific error types