API aggiornamento/inserimento consensi

Introduzione

L'API registra i consensi forniti (o negati) da un utente per un testo legale.

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

Parametri

Nome	Locazione	Descrizione	Obbligatorio
code	path	Il codice del testo legale	✔
userId	path	L'identificativo dell'utente	✔

Richiesta

{
  "preferences": [
    {
      "id": 1,
      "accepted": true
    }
  ]
}

Parametro	Descrizione
id	Identificativo della preferenza da accettare o rifiutare

Esempi

cUrl

JavaScript

JavaScript XHR

PHP

curl -X PUT 'https://api.corypha.app/app/v1/policies/{code}/users/{userid}' \
  -H 'X-API-KEY: aaaa-bbbb-cccc-dddd-eeee' \
  -d '{
  "preferences": [
    {
      "id": 1,
      "accepted": false
    }
  ]
}'

import axios from 'axios';

axios({
    url: 'https://api.corypha.app/app/v1/policies/{code}/users/{userid}',
    method: 'put',
    headers: { 'X-API-KEY': 'aaaa-bbbb-cccc-dddd-eeee' },
    data: {
        "preferences": [
            {
                "id": 1,
                "accepted": false
            }
        ]
    }
})

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

xhr.open("PUT", "https://api.corypha.app/app/v1/policies/{code}/users/{userid}");
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_PUT);

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

$request->setBody('{
  "preferences": [
    {
      "id": 1,
      "accepted": false
    }
  ]
}');

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

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

Risposta

204

400

401

403

404

//

Perchè? https://httpstatuses.com/204

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

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

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

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