...
HTML |
---|
<div class="content"> <section id="panoramica" class="resource-group"> <h2 class="group-heading">Panoramica <a href="#panoramica" class="permalink">¶</a></h2> <h2 id="header-introduzione">Introduzione <a class="permalink" href="#header-introduzione" aria-hidden="true">¶</a></h2> <p>La Easy Privacy API consente ad uno sviluppatore di creare delle Privacy Policy e richiederne successivamente ai suoi utenti il relativo consenso.</p> </section> <section id="sicurezza" class="resource-group"> <h2 class="group-heading">Sicurezza <a href="#sicurezza" class="permalink">¶</a></h2> <h2 id="header-autenticazione">Autenticazione <a class="permalink" href="#header-autenticazione" aria-hidden="true">¶</a></h2> <p>L’API EasyPrivacy descritta in questo documento adotterà il meccanismo di autenticazione che si basa su un API-Key. L’API-Key sarà fornita nel parametro <code>KeyId</code> dell’header http della richiesta.</p> </section> <section id="policies" class="resource-group"> <h2 class="group-heading">Policies <a href="#policies" class="permalink">¶</a></h2> <div id="policies-policy" class="resource"> <h3 class="resource-heading">Policy <a href="#policies-policy" class="permalink"> ¶</a></h3> <p>La risorsa Policy esposta tramite questa API.</p> <div id="policies-policy-post" class="action post"> <h4 class="action-heading"><div class="name">Crea</div><a href="#policies-policy-post" class="method post">POST</a><code class="uri">/privacy/v3/policy</code></h4> <p>Crea una Policy.</p> <h4>Example URI</h4> <div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/privacy/v3/policy</span> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"In questa sezione sono raccolti i principali riferimenti normativi che dovranno essere accettati"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Lorem Ipsum"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"http://my.site.it/endpoint"</span></span>, "<span class="hljs-attribute">nomeRichiedente</span>": <span class="hljs-value"><span class="hljs-string">"Lorem Ipsum"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Testo della normativa."</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della Policy"</span> </span>}</span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lo sviluppatore verrà notificato ad ogni cambio stato dei consensi tramite una chiamata REST in POST verso l’url fornito."</span> </span>}</span>, "<span class="hljs-attribute">nomeRichiedente</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome richiedente."</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"normativaPrivacy"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"nomeRichiedente"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo della privacy Policy"</span> </span>}</span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Testo della normativa della Policy"</span> </span>}</span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato della policy"</span> </span>}</span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"TimOpenId dello sviluppatore"</span> </span>}</span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome del richiedente"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"timOpenId"</span>, <span class="hljs-string">"nome"</span> ] </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Data della creazione della Policy"</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della policy"</span> </span>}</span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"URI a cui viene inviata la notifica dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"normativaPrivacy"</span>, <span class="hljs-string">"stato"</span>, <span class="hljs-string">"sviluppatore"</span>, <span class="hljs-string">"dataCreazione"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"redirectUrl"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="policies-policy-1" class="resource"> <h3 class="resource-heading">Policy <a href="#policies-policy-1" class="permalink"> ¶</a></h3> <p>La risorsa Policy esposta tramite questa API.</p> <div id="policies-policy-put" class="action put"> <h4 class="action-heading"><div class="name">Attiva/Disattiva</div><a href="#policies-policy-put" class="method put">PUT</a><code class="uri">/privacy/v3/policy/{idPrivacyPolicy}{?active}</code></h4> <p>Attiva o disattiva una Policy.</p> <h4>Example URI</h4> <div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/privacy/v3/policy/<span class="hljs-attribute" title="idPrivacyPolicy">5981f1812d040e1a386a3c40</span>?<span class="hljs-attribute">active=</span><span class="hljs-literal">true</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>idPrivacyPolicy</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40</span></span> <p>Identificativo della Policy da attivare o disattivare.</p> </dd><dt>active</dt> <dd><code>boolean</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>true</span></span> <p>Valori possibili (Attiva: <code>true</code>,Disattiva: <code>false</code>)</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo della privacy Policy"</span> </span>}</span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Testo della normativa della Policy"</span> </span>}</span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato della policy"</span> </span>}</span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"TimOpenId dello sviluppatore"</span> </span>}</span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome del richiedente"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"timOpenId"</span>, <span class="hljs-string">"nome"</span> ] </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Data della creazione della Policy"</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della policy"</span> </span>}</span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"URI a cui viene inviata la notifica dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"normativaPrivacy"</span>, <span class="hljs-string">"stato"</span>, <span class="hljs-string">"sviluppatore"</span>, <span class="hljs-string">"dataCreazione"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"redirectUrl"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="policies-policy-2" class="resource"> <h3 class="resource-heading">Policy <a href="#policies-policy-2" class="permalink"> ¶</a></h3> <p>La risorsa Policy esposta tramite questa API.</p> <div id="policies-policy-get" class="action get"> <h4 class="action-heading"><div class="name">Elenco</div><a href="#policies-policy-get" class="method get">GET</a><code class="uri">/privacy/v3/policy{?nomePolicy,stato}</code></h4> <p>Recupera la lista delle policies create.</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/policy?<span class="hljs-attribute">nomePolicy=</span><span class="hljs-literal">5981f1812d040e1a386a3c40<>nome_policy</span>&<span class="hljs-attribute">stato=</span><span class="hljs-literal">true</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>nomePolicy</dt> <dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40<strong><span>nome_policy</span></span> <p>Identificativo della Policy da ricercare.</p> </dd><dt>stato</dt> <dd><code>boolean</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>true</span></span> <p>Stato delle policies</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">policies</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} ] </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">policies</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"policies"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="policies-operazioni" class="resource"> <h3 class="resource-heading">Operazioni <a href="#policies-operazioni" class="permalink"> ¶</a></h3> <p>La risorsa Operazioni esposta tramite questa API.</p> <div id="policies-operazioni-get" class="action get"> <h4 class="action-heading"><div class="name">Recupera Storico</div><a href="#policies-operazioni-get" class="method get">GET</a><code class="uri">/privacy/v3/policy/{idPrivacyPolicy}/operazioni</code></h4> <p>Recupera lo storico delle operazioni effettuate su una Policy.</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/policy/<span class="hljs-attribute" title="idPrivacyPolicy">5981f1812d040e1a386a3c40</span>/operazioni</span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>idPrivacyPolicy</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40<strong><span></span></span> <p>Identificativo della Policy.</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">operazioni</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">tipo</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} ] </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo della privacy Policy"</span> </span>}</span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Testo della normativa della Policy"</span> </span>}</span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato della policy"</span> </span>}</span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"TimOpenId dello sviluppatore"</span> </span>}</span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome del richiedente"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"timOpenId"</span>, <span class="hljs-string">"nome"</span> ] </span>}</span>, "<span class="hljs-attribute">dataCreazione</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Data della creazione della Policy"</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della policy"</span> </span>}</span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"URI a cui viene inviata la notifica dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">operazioni</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"normativaPrivacy"</span>, <span class="hljs-string">"stato"</span>, <span class="hljs-string">"sviluppatore"</span>, <span class="hljs-string">"dataCreazione"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"redirectUrl"</span>, <span class="hljs-string">"operazioni"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> </section> <section id="consensi" class="resource-group"> <h2 class="group-heading">Consensi <a href="#consensi" class="permalink">¶</a></h2> <div id="consensi-consenso" class="resource"> <h3 class="resource-heading">Consenso <a href="#consensi-consenso" class="permalink"> ¶</a></h3> <p>La risorsa Consenso esposta tramite questa API.</p> <div id="consensi-consenso-post" class="action post"> <h4 class="action-heading"><div class="name">Richiedi</div><a href="#consensi-consenso-post" class="method post">POST</a><code class="uri">/privacy/v3/consenso{?sms}</code></h4> <p>Richiedi il Consenso per una specifica Policy</p> <h4>Example URI</h4> <div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/privacy/v3/consenso?<span class="hljs-attribute">sms=</span><span class="hljs-literal">false</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>sms</dt> <dd><code>boolean</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>false</span></span> <p>Indica se l’utente dovrà ricevere la notifica di richiesta consenso tramite un sms <code>true</code> o no <code>false</code></p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">idPrivacyPolicy</span>": <span class="hljs-value"><span class="hljs-string">"5981f1812d040e1a386a3c40"</span></span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value"><span class="hljs-string">"3323923923"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">idPrivacyPolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo della Policy."</span> </span>}</span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Numero di telefono."</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"idPrivacyPolicy"</span>, <span class="hljs-string">"phoneNumber"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">applicazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataConsenso</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">idPrivacyPolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">operazioni</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">tipo</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} ]</span>, "<span class="hljs-attribute">link</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo del consenso"</span> </span>}</span>, "<span class="hljs-attribute">applicazione</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome dell'applicazione"</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della policy"</span> </span>}</span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato del consenso"</span> </span>}</span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Testo della normativa della Policy"</span> </span>}</span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"TimOpenId dello sviluppatore"</span> </span>}</span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome del richiedente"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"timOpenId"</span>, <span class="hljs-string">"nome"</span> ] </span>}</span>, "<span class="hljs-attribute">dataConsenso</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span> </span>}</span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Numero di telefono per cui è stato richiesto il consenso"</span> </span>}</span>, "<span class="hljs-attribute">idPrivacyPolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Id della privacy Policy per cui è stato richiesto il consenso"</span> </span>}</span>, "<span class="hljs-attribute">operazioni</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span> </span>}</span>, "<span class="hljs-attribute">link</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Link di accesso per l'utente alla gestione consensi"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"applicazione"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"stato"</span>, <span class="hljs-string">"normativaPrivacy"</span>, <span class="hljs-string">"sviluppatore"</span>, <span class="hljs-string">"dataConsenso"</span>, <span class="hljs-string">"phoneNumber"</span>, <span class="hljs-string">"idPrivacyPolicy"</span>, <span class="hljs-string">"operazioni"</span>, <span class="hljs-string">"link"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="consensi-stato" class="resource"> <h3 class="resource-heading">Stato <a href="#consensi-stato" class="permalink"> ¶</a></h3> <p>La risorsa Stato esposta tramite questa API.</p> <div id="consensi-stato-get" class="action get"> <h4 class="action-heading"><div class="name">Recupera Stato</div><a href="#consensi-stato-get" class="method get">GET</a><code class="uri">/privacy/v3/consenso/verifica{?idPrivacyPolicy,phoneNumber}</code></h4> <p>Recupera lo stato del Consenso per una specifica Policy</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/consenso/verifica?<span class="hljs-attribute">idPrivacyPolicy=</span><span class="hljs-literal">5981f1812d040e1a386a3c40</span>&<span class="hljs-attribute">phoneNumber=</span><span class="hljs-literal">3323923923</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>idPrivacyPolicy</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40</span></span> <p>Identificativo della Policy.</p> </dd><dt>phoneNumber</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>3323923923</span></span> <p>Numero di telefono.</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">descrizione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span> </span>}</span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato del Consenso"</span> </span>}</span>, "<span class="hljs-attribute">descrizione</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"nome"</span>, <span class="hljs-string">"descrizione"</span> ] </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="consensi-consenso-1" class="resource"> <h3 class="resource-heading">Consenso <a href="#consensi-consenso-1" class="permalink"> ¶</a></h3> <p>La risorsa Consenso esposta tramite questa API.</p> <div id="consensi-consenso-get" class="action get"> <h4 class="action-heading"><div class="name">Recupera Elenco</div><a href="#consensi-consenso-get" class="method get">GET</a><code class="uri">/privacy/v3/consenso/{?idPrivacyPolicy,phoneNumber,stato}</code></h4> <p>Ottieni la lista dei consensi relativi ad una Policy.</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/consenso/?<span class="hljs-attribute">idPrivacyPolicy=</span><span class="hljs-literal">5981f1812d040e1a386a3c40</span>&<span class="hljs-attribute">phoneNumber=</span><span class="hljs-literal">3323923923</span>&<span class="hljs-attribute">stato=</span><span class="hljs-literal">true</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>idPrivacyPolicy</dt> <dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40</span></span> <p>Identificativo della Policy.</p> </dd><dt>phoneNumber</dt> <dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>3323923923</span></span> <p>Numero di telefono.</p> </dd><dt>stato</dt> <dd><code>boolean</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>true</span></span> <p>Stato del consenso.</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">applicazione</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">stato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">normativaPrivacy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">sviluppatore</span>": <span class="hljs-value">{ "<span class="hljs-attribute">timOpenId</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nome</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">dataConsenso</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">idPrivacyPolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">operazioni</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">tipo</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} ]</span>, "<span class="hljs-attribute">link</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>} ] </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span>, <span class="hljs-string">"data"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> <div id="consensi-consenso-2" class="resource"> <h3 class="resource-heading">Consenso <a href="#consensi-consenso-2" class="permalink"> ¶</a></h3> <p>La risorsa Consenso esposta tramite questa API.</p> <div id="consensi-consenso-put" class="action put"> <h4 class="action-heading"><div class="name">Stato</div><a href="#consensi-consenso-put" class="method put">PUT</a><code class="uri">/privacy/v3/consenso/{idConsenso}</code></h4> <p>Nega Consenso</p> <h4>Example URI</h4> <div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/privacy/v3/consenso/<span class="hljs-attribute" title="idConsenso">5981f1812d040e1a386a3c40</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>idConsenso</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>5981f1812d040e1a386a3c40</span></span> <p>Identificativo del Consenso da negare.</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">vecchioStato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">nuovoStato</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Identificativo del consenso"</span> </span>}</span>, "<span class="hljs-attribute">phoneNumber</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Numero di telefono per cui è stato richiesto il consenso"</span> </span>}</span>, "<span class="hljs-attribute">nomePolicy</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Nome della policy"</span> </span>}</span>, "<span class="hljs-attribute">vecchioStato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato precedente del consenso"</span> </span>}</span>, "<span class="hljs-attribute">nuovoStato</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Stato attuale del consenso"</span> </span>}</span>, "<span class="hljs-attribute">redirectUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"URI a cui viene inviata la notifica dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"id"</span>, <span class="hljs-string">"phoneNumber"</span>, <span class="hljs-string">"nomePolicy"</span>, <span class="hljs-string">"vecchioStato"</span>, <span class="hljs-string">"nuovoStato"</span>, <span class="hljs-string">"redirectUrl"</span> ] </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> </section> <section id="loghi" class="resource-group"> <h2 class="group-heading">Loghi <a href="#loghi" class="permalink">¶</a></h2> <div id="loghi-logo" class="resource"> <h3 class="resource-heading">Logo <a href="#loghi-logo" class="permalink"> ¶</a></h3> <p>La risorsa Logo esposta tramite questa API permette di personalizzare il logo in homepage e nella barra di navigazione. Se non impostato verrà utilizzato un logo di default.</p> <div id="loghi-logo-post" class="action post"> <h4 class="action-heading"><div class="name">Crea Logo</div><a href="#loghi-logo-post" class="method post">POST</a><code class="uri">/privacy/v3/logo</code></h4> <p>Crea il Logo fornendo gli attributi richiesti.</p> <h4>Example URI</h4> <div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/privacy/v3/logo</span> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">urlLogoHome</span>": <span class="hljs-value"><span class="hljs-string">"http://www.google.it/apple/homelogo.gif"</span></span>, "<span class="hljs-attribute">urlLogoNavigation</span>": <span class="hljs-value"><span class="hljs-string">"http://www.google.it/apple/navigationlogo.gif"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">urlLogoHome</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url file logo pagina Home"</span> </span>}</span>, "<span class="hljs-attribute">urlLogoNavigation</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url file logo Navigation"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"urlLogoHome"</span>, <span class="hljs-string">"urlLogoNavigation"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">logoHomeUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">logoNavigationUrl</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">logoHomeUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url file logo pagina Home,"</span> </span>}</span>, "<span class="hljs-attribute">logoNavigationUrl</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url file logo Navigation"</span> </span>} </span>} </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> <div id="loghi-logo-put" class="action put"> <h4 class="action-heading"><div class="name">Aggiorna Logo</div><a href="#loghi-logo-put" class="method put">PUT</a><code class="uri">/privacy/v3/logo{?type}</code></h4> <p>Aggiorna la url del Logo di Navigazione o quella della pagina Home.</p> <h4>Example URI</h4> <div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/privacy/v3/logo?<span class="hljs-attribute">type=</span><span class="hljs-literal">home</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>type</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>home</span></span> <p>Tipologia del logo, valori possibili: [home,navigation].</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">urlLogo</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">urlLogo</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url del file logo"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"urlLogo"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url logo"</span> </span>} </span>} </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> <div id="loghi-logo-get" class="action get"> <h4 class="action-heading"><div class="name">Leggi Logo</div><a href="#loghi-logo-get" class="method get">GET</a><code class="uri">/privacy/v3/logo{?type}</code></h4> <p>Leggi la url del Logo di Navigazione o quella della pagina Home.</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/logo?<span class="hljs-attribute">type=</span><span class="hljs-literal">home</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>type</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>home</span></span> <p>Tipologia del logo, valori possibili: [home,navigation].</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url logo"</span> </span>} </span>} </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> <div id="loghi-logo-delete" class="action delete"> <h4 class="action-heading"><div class="name">Elimina Logo</div><a href="#loghi-logo-delete" class="method delete">DELETE</a><code class="uri">/privacy/v3/logo{?type}</code></h4> <p>Elimina la url del Logo di Navigazione o quella della pagina Home.</p> <h4>Example URI</h4> <div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/privacy/v3/logo?<span class="hljs-attribute">type=</span><span class="hljs-literal">home</span></span> </div> <div class="title"><strong>URI Parameters</strong> <div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <dl class="inner"><dt>type</dt> <dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>home</span></span> <p>Tipologia del logo, valori possibili: [home,navigation].</p> </dd> </dl> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">url</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Url logo"</span> </span>} </span>} </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> </section> <section id="shortname" class="resource-group"> <h2 class="group-heading">ShortName <a href="#shortname" class="permalink">¶</a></h2> <div id="shortname-shortname" class="resource"> <h3 class="resource-heading">ShortName <a href="#shortname-shortname" class="permalink"> ¶</a></h3> <p>La risorsa ShortCompanyName esposta tramite questa API permette di personalizzare il link all’applicazione consensi, di default viene valorizzato con il nome dell’azienda.</p> <div id="shortname-shortname-post" class="action post"> <h4 class="action-heading"><div class="name">Scegli ShortName</div><a href="#shortname-shortname-post" class="method post">POST</a><code class="uri">/privacy/v3/shortname</code></h4> <p>Crea l’identificativo della company da usare per la personalizzazione di EasyPrivacy - Lo ShortCompanyName può contenere solo lettere alfabetiche.</p> <h4>Example URI</h4> <div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/privacy/v3/shortname</span> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value"><span class="hljs-string">"apple"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ShortCompanyName associato all'azienda."</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"shortName"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ShortCompanyName dell'azienda"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"shortName"</span> ] </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> <div id="shortname-shortname-put" class="action put"> <h4 class="action-heading"><div class="name">Aggiorna ShortName</div><a href="#shortname-shortname-put" class="method put">PUT</a><code class="uri">/privacy/v3/shortname</code></h4> <p>Aggiorna l’identificativo della company da usare per la personalizzazione di EasyPrivacy - Lo ShortCompanyName può contenere solo lettere alfabetiche.</p> <h4>Example URI</h4> <div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/privacy/v3/shortname</span> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value"><span class="hljs-string">"apple"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ShortCompanyName associato all'azienda."</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"shortName"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ShortCompanyName dell'azienda"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"shortName"</span> ] </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> <div id="shortname-shortname-get" class="action get"> <h4 class="action-heading"><div class="name">Leggi ShortName</div><a href="#shortname-shortname-get" class="method get">GET</a><code class="uri">/privacy/v3/shortname</code></h4> <p>Leggi l’identificativo della company da usare per la personalizzazione di EasyPrivacy</p> <h4>Example URI</h4> <div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/privacy/v3/shortname</span> </div> <div class="title"><strong>Request</strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">KeyId</span>: <span class="hljs-string">d93decd9-b053-47ba-be26-d1da62942ff1</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>200</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Operazione eseguita con successo</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> <h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Hello, world!"</span> </span>}</code></pre> <div style="height: 1px;"></div> <h5>Schema</h5><pre><code>{ "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">shortName</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"ShortCompanyName dell'azienda"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"shortName"</span> ] </span>}</span>, "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Esito dell'operazione"</span> </span>}</span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value">{ "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Descrizione dell'operazione"</span> </span>} </span>}</span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value">[ <span class="hljs-string">"data"</span>, <span class="hljs-string">"status"</span>, <span class="hljs-string">"description"</span> ] </span>}</code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>400</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>La richiesta non è stata formulata in maniera corretta.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>404</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Risorsa non trovata</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>403</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore di autenticazione</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">text/plain</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>412</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> <div class="title"><strong>Response <code>500</code></strong> <div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div> </div> <div class="collapse-content"> <div class="inner"> <div class="description"> <p>Errore generico del server</p> </div> <h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre> <div style="height: 1px;"></div> </div> </div> </div> </div> </section> </div> |
...