List all consent records

GET 
/service/individual/record/data-agreement/:dataAgreementId/all

This endpoint is used to list all consent records existing for a data agreement for an organisation defined in the consent building block. The response is paginated.

Request

Path Parameters

dataAgreementId stringrequired

Unique ID of an object

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

Header Parameters

X-ConsentBB-IndividualId stringrequired

Individual Id

Responses

200

Response Headers

application/json

Schema

Schema

consentRecords object[]
Array [
id stringrequired
Objects may be passed back by some API endpoints without an id (PK), denoting that they are a "draft", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated.
dataAgreementId string
The DataAgreement to which consent has been given
dataAgreementRevisionId string
The Revision of the data agreement which consent has been given to
dataAgreementRevisionHash string
Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement.
individualId string
The Individual who has signed this consent record
optIn boolean
True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent).
state stringrequired
Possible values: [unsigned, signed]
The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed
signatureId string
A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?
sectorPreferences object[]
Array [
sector stringrequired
Name of the sector
optIn boolean
Defines sector is opted in or not
isLastUpdated boolean
Defines consent record for this sector is last updated
]
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreementId": "string",
      "dataAgreementRevisionId": "string",
      "dataAgreementRevisionHash": "",
      "individualId": "string",
      "optIn": "",
      "state": "",
      "signatureId": "string",
      "sectorPreferences": [
        {
          "sector": "",
          "optIn": true,
          "isLastUpdated": true
        }
      ]
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...