API storico consensi

Introduzione

L'API restituisce i consensi forniti (o negati) da un utente per un dato testo legale. Ogni consenso include informazioni quali il nome e l'obbligatorietà della preferenza al momento dell'accettazione.

GET /app/v1/policies/{code}/users/{userid}

Parametri

Nome	Locazione	Descrizione	Obbligatorio	Note
code	path	Il codice del testo legale	✔
userId	path	L'identificativo dell'utente	✔
sort	query	Permette di ordinare i risultati per timestamp	✗	Valori consentiti: ASC, DESC
limit	query	Limita il numero dei risultati per pagina	✗
offset	query	Quanti elementi saltare prima dei risultati attuali	✗

Esempi

cUrl

JavaScript

JavaScript XHR

PHP

curl -X GET \
  'https://api.corypha.app/app/v1/policies/{code}/users/{userid}?sort=ASC&limit=10&offset=0' \
  -H 'X-API-KEY: aaaa-bbbb-cccc-dddd-eeee

import axios from 'axios';

axios({
    url: 'https://api.corypha.app/app/v1/policies/{code}/users/{userid}?sort=ASC&limit=10&offset=0',
    method: 'get',
    headers: {
        'X-API-KEY': 'aaaa-bbbb-cccc-dddd-eeee'
    }
})

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.open("GET", "https://api.corypha.app/app/v1/policies/{code}/users/{userid}?sort=ASC&limit=10&offset=0");
xhr.setRequestHeader("X-API-KEY", "aaaa-bbbb-cccc-dddd-eeee");

xhr.send();

<?php

$request = new HttpRequest();
$request->setUrl('https://api.corypha.app/app/v1/policies/{code}/users/{userid}');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'sort' => 'ASC',
  'limit' => '10',
  'offset' => '0'
));

$request->setHeaders(array(
  'X-API-KEY' => 'aaaa-bbbb-cccc-dddd-eeee'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Risposta

200

400

401

404

[
   {
    "id": 1,
    "name": "Name of policy",
    "required": true,
    "accepted": true,
    "timestamp": "2019-08-30T10:05:36.000Z",
    "policy": {
      "name": "Corypha",
      "code": "corypha-policy"
    },
    "version": {
      "number": 1,
      "date": "2019-08-01T00:00:00.000Z",
      "lang": "it",
      "code": "abcdef",
      "hash": "b89eaac7e61417341b710b727768294d0e6a277b",
      "text": "Testo della versione..."
    }
  }
]

{
    "status": 400,
    "message": "Invalid ID or userID supplied"
}

{
    "status": 401,
    "message": "Unauthorized"
}

{
    "status": 404,
    "message": "Policy not found"
}