List consent record history

GET 
/service/individual/record/consent-record/history

This endpoint is used to list all consent record history existing for an individual in an organisation defined in the consent building block. The response is paginated.

Request

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

OK

Response Headers

application/json

Schema

Schema

consentRecordHistory object

id stringrequired

Data agreement record history Id

organisationId stringrequired

Organisation Id

dataAgreementId stringrequired

Data agreement Id

log stringrequired

Log string

timestamp stringrequired

Timestamp in ISO 8601 date time format

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)

{
  "consentRecordHistory": {
    "id": "64e91591e2f6a8000142c665",
    "organisationId": "603e683c69dd720001c74f93",
    "dataAgreementId": "61e183127c81650001f97d43",
    "log": "Updated consent value to <Allow> for the purpose <Customer Loyalty Card Issuance> in organisation <The Retail Company (Germany)>",
    "timestamp": "2023-08-25T20:56:49Z"
  },
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...