API visualizzazione policy corrente

Descrizione

L'API restituisce la versione corrente di un testo legale.

GET /app/v1/policies/{code}

Parametri

Nome	Locazione	Descrizione	Obbligatorio	Note
code	path	Il codice del testo legale	✔
lang	query	La lingua di preferenza dell'utente	✔	Formato ISO 639-2
userId	query	userId per conoscere l'accettazione dei consensi all'attuale versione

Esempi

cUrl

JavaScript

JavaScript (XHR)

PHP

curl -X GET \
  'https://api.corypha.app/app/v1/policies/{code}?lang={langCode}' \
  -H 'X-API-KEY: aaaa-bbbb-cccc-dddd-eeee' \

import axios from 'axios';

axios({
    url: 'https://api.corypha.app/app/v1/policies/{code}?lang={langCode}',
    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}?lang={langCode}");
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}');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'lang' => '{langCode}'
));

$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

403

404

{
    "id": 1,
    "code": "corypha-policy",
    "name": "corypha-policy-name",
    "version": {
        "id": 2,
        "number": 2,
        "date": "2019-09-12T14:33:51.000Z",
        "lang": "it",
        "code": "policy-2",
        "hash": "4801b6de45e66aa7eb3a6157d4d225e6aeaa2f04",
        "text": "Testo della versione...",
        "preferences": [
            {
                "id": 10,
                "name": "Preferenza1",
                "required": true,
                "accepted": true, // se userId in queryString
            },
            {
                "id": 11,
                "name": "Preferenza2",
                "required": true,
                "accepted": false, // se userId in queryString
            }
        ]
    }
}

{
    "status": 400,
    "message": "Lang not supplied in query string"
}

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

{
    "status": 403,
    "message": "You have reached your monthly quota!"
}

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