Passer au contenu

Provides a filtered list of consents

Requête

En-têtes
apiKeystringobligatoire
Corpsapplication/json

The parameters to filter by

agreementGroupGuidstring or null, (uuid)
externalIDstring or null
Exemple:"3fa85f64-5717-4562-b3fc-2c963f66afa6"
userIdentifierstring or null
dateFromstring or null, (date-time)
Exemple:"2020/04/01"
dateTostring or null, (date-time)
Exemple:"2030/04/01"
platformstring or null
enviromentinteger, (int32)(EnviromentEnum)
Enum:01
versionstring or null
getScreenshotboolean
pageinteger, (int32), [ 0 .. 2147483647 ]
Exemple:0
itemsPerPageinteger, (int32), [ 1 .. 5000 ]
Exemple:20
curl -i -X POST \
  http://localhost/api/Consent/List \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "agreementGroupGuid": "770963cd-b340-45fc-b4ac-6f58c2b4e58d",
    "externalID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userIdentifier": "string",
    "dateFrom": "2020/04/01",
    "dateTo": "2030/04/01",
    "platform": "string",
    "enviroment": 0,
    "version": "string",
    "getScreenshot": true,
    "page": 0,
    "itemsPerPage": 20
  }'

Réponses

Success

Corpsapplication/json
Array [
guidstring, (uuid)
agreementobject(AgreementOutputViewModel)
fieldCollectionstring or null
consentDatestring, (date-time)
platformstring or null
userIdentifierstring or null
clausesArray of objects or null(ClausesViewModel)
blockchainProcessIdstring or null
blockchainTxHashstring or null
agreementHashstring or null
blockchainStatusinteger, (int32)(ConsentStatusEnum)
Enum:012345678
blockchainStatusDatestring, (date-time)
externalIDstring or null
blockchainUuidstring or null
screenshotstring or null, (byte)
consentGroupGuidstring, (uuid)
userIpstring or null
]
Réponse
[ { "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc", "agreement": { … }, "fieldCollection": "string", "consentDate": "2019-08-24T14:15:22Z", "platform": "string", "userIdentifier": "string", "clauses": [ … ], "blockchainProcessId": "string", "blockchainTxHash": "string", "agreementHash": "string", "blockchainStatus": 0, "blockchainStatusDate": "2019-08-24T14:15:22Z", "externalID": "string", "blockchainUuid": "string", "screenshot": "string", "consentGroupGuid": "fbcb1e92-2897-4fbc-a84f-cec8496772aa", "userIp": "string" } ]