design/api/metacategory.html
changeset 116 672e3c4bbd0c
child 133 6f3078f7fd47
equal deleted inserted replaced
115:b5d11572f1ed 116:672e3c4bbd0c
       
     1 <!DOCTYPE html><html><head><meta charset="utf-8"><title>API</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#">Resource Group</a></div><div class="collapse-content"><ul><li><a href="#collection-de-protocoles">Collection de protocoles</a><ul><li><a href="#collection-de-protocoles-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Voir la liste des protocoles</a></li><li><a href="#collection-de-protocoles-post"><span class="badge post"><i class="fa fa-plus"></i></span>Créer un nouveau protocole</a></li></ul></li><li><a href="#révisions-d-un-protocole.">Révisions d'un protocole.</a><ul><li><a href="#révisions-d-un-protocole.-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Voir la liste des revision pour un protocole</a></li><li><a href="#révisions-d-un-protocole.-post"><span class="badge post"><i class="fa fa-plus"></i></span>Créer une nouvelle révision du protocole</a></li></ul></li><li><a href="#détail-d-un-protocole-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Voir une revision d'un protocole</a></li><li><a href="#détail-méta-catégorie-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Voir le détail d'une méta-catégorie</a></li></ul></div></div></nav><div class="content"><header><h1 id="top">API</h1></header><p>Documentation de l’API d’édition des protocoles d’annotation.</p>
       
     2 <p>Tous les endpoint de cet API demande une authentification par token.
       
     3 Toutes les requêtes doievnt donc comporter l’en-tête suivant :</p>
       
     4 <pre><code class="language-http"><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b</span></code></pre>
       
     5 <section id="" class="resource-group"><h2 class="group-heading">Resource Group <a href="#" class="permalink">&para;</a></h2><div id="collection-de-protocoles" class="resource"><h3 class="resource-heading">Collection de protocoles <a href="#collection-de-protocoles" class="permalink">&nbsp;&para;</a></h3><div id="collection-de-protocoles-get" class="action get"><h4 class="action-heading"><div class="name">Voir la liste des protocoles</div><a href="#collection-de-protocoles-get" class="method get">GET</a><code class="uri">/protocol/{?page,page_size}</code></h4><p>Liste les protocoles pour une application. L’application est déterminée par le token passé comme authentification.</p>
       
     6 <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/?<span class="hljs-attribute">page=</span><span class="hljs-literal">3</span>&<span class="hljs-attribute">page_size=</span><span class="hljs-literal">15</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>page</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>1</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>3</span></span><p>Get the page.</p>
       
     7 </dd><dt>page_size</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>10</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>15</span></span><p>Set number of protocol per page</p>
       
     8 </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">Authorization</span>: <span class="hljs-string">Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>{
       
     9   "<span class="hljs-attribute">count</span>": <span class="hljs-value"><span class="hljs-number">15</span></span>,
       
    10   "<span class="hljs-attribute">next</span>": <span class="hljs-value"><span class="hljs-string">"http://scatedit.episteme.fr/api/protocol/?page=2"</span></span>,
       
    11   "<span class="hljs-attribute">prev</span>": <span class="hljs-value"><span class="hljs-string">"null"</span></span>,
       
    12   "<span class="hljs-attribute">results</span>": <span class="hljs-value">[
       
    13     {
       
    14       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"a4977c1f-4752-4aff-b724-eec4033af25c"</span></span>,
       
    15       "<span class="hljs-attribute">owner</span>": <span class="hljs-value"><span class="hljs-string">"group1"</span></span>,
       
    16       "<span class="hljs-attribute">revision_number</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
       
    17       "<span class="hljs-attribute">last_description</span>": <span class="hljs-value"><span class="hljs-string">"Cras rutrum lacinia pretium. Suspendisse justo est, tincidunt sed tellus a, sodales suscipit risus. Curabitur odio tortor, tincidunt sed est nec, ullamcorper sodales velit."</span>
       
    18     </span>}
       
    19   ]
       
    20 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
    21   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
    22   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
    23   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
    24     "<span class="hljs-attribute">count</span>": <span class="hljs-value">{
       
    25       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
    26     </span>}</span>,
       
    27     "<span class="hljs-attribute">next</span>": <span class="hljs-value">{
       
    28       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    29     </span>}</span>,
       
    30     "<span class="hljs-attribute">prev</span>": <span class="hljs-value">{
       
    31       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    32     </span>}</span>,
       
    33     "<span class="hljs-attribute">results</span>": <span class="hljs-value">{
       
    34       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span></span>,
       
    35       "<span class="hljs-attribute">items</span>": <span class="hljs-value">{
       
    36         "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
    37         "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
    38           "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
    39             "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    40           </span>}</span>,
       
    41           "<span class="hljs-attribute">owner</span>": <span class="hljs-value">{
       
    42             "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    43           </span>}</span>,
       
    44           "<span class="hljs-attribute">revision_number</span>": <span class="hljs-value">{
       
    45             "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
    46           </span>}</span>,
       
    47           "<span class="hljs-attribute">last_description</span>": <span class="hljs-value">{
       
    48             "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    49           </span>}
       
    50         </span>}
       
    51       </span>}
       
    52     </span>}
       
    53   </span>}
       
    54 </span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="collection-de-protocoles-post" class="action post"><h4 class="action-heading"><div class="name">Créer un nouveau protocole</div><a href="#collection-de-protocoles-post" class="method post">POST</a><code class="uri">/protocol/</code></h4><p>Crée un nouveau protocole d’annotation dont la liste des méta-catégorie est la liste des méta-catégories par défaut pour l’application.</p>
       
    55 <p>Le numéro de révision retourné sera toujours <code>1</code>.</p>
       
    56 <h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/</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">Authorization</span>: <span class="hljs-string">Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
       
    57   "<span class="hljs-attribute">owner</span>": <span class="hljs-value"><span class="hljs-string">"group1"</span></span>,
       
    58   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span>
       
    59 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
    60   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
    61   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
    62   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
    63     "<span class="hljs-attribute">owner</span>": <span class="hljs-value">{
       
    64       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    65     </span>}</span>,
       
    66     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
    67       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    68     </span>}
       
    69   </span>}
       
    70 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>201</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>{
       
    71   "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
    72   "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
    73   "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
    74   "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
    75   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
    76   "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
    77   "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
       
    78   "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">[
       
    79     {
       
    80       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
    81       "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
    82       "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
    83       "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
    84       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
    85       "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
    86       "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
       
    87     </span>}
       
    88   ]
       
    89 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
    90   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
    91   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
    92   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
    93     "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
    94       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
    95     </span>}</span>,
       
    96     "<span class="hljs-attribute">revision</span>": <span class="hljs-value">{
       
    97       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
    98     </span>}</span>,
       
    99     "<span class="hljs-attribute">base</span>": <span class="hljs-value">{
       
   100       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   101     </span>}</span>,
       
   102     "<span class="hljs-attribute">name</span>": <span class="hljs-value">{
       
   103       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   104     </span>}</span>,
       
   105     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
   106       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   107     </span>}</span>,
       
   108     "<span class="hljs-attribute">color</span>": <span class="hljs-value">{
       
   109       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   110     </span>}</span>,
       
   111     "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value">{
       
   112       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"boolean"</span>
       
   113     </span>}</span>,
       
   114     "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">{
       
   115       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span>
       
   116     </span>}
       
   117   </span>}
       
   118 </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="révisions-d-un-protocole." class="resource"><h3 class="resource-heading">Révisions d'un protocole. <a href="#révisions-d-un-protocole." class="permalink">&nbsp;&para;</a></h3><div id="révisions-d-un-protocole.-get" class="action get"><h4 class="action-heading"><div class="name">Voir la liste des revision pour un protocole</div><a href="#révisions-d-un-protocole.-get" class="method get">GET</a><code class="uri">/protocol/{id}/{?page,page_size}</code></h4><p>Liste les revisions d’un protocole pour une application.</p>
       
   119 <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/<span class="hljs-attribute" title="id">a4977c1f-4752-4aff-b724-eec4033af25c</span>/?<span class="hljs-attribute">page=</span><span class="hljs-literal">3</span>&<span class="hljs-attribute">page_size=</span><span class="hljs-literal">15</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>id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>a4977c1f-4752-4aff-b724-eec4033af25c</span></span><p>Identifiant d’un protocole</p>
       
   120 </dd><dt>page</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>1</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>3</span></span><p>Get the page.</p>
       
   121 </dd><dt>page_size</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>10</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>15</span></span><p>Set number of protocol per page</p>
       
   122 </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">Authorization</span>: <span class="hljs-string">Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>{
       
   123   "<span class="hljs-attribute">count</span>": <span class="hljs-value"><span class="hljs-string">"15"</span></span>,
       
   124   "<span class="hljs-attribute">next</span>": <span class="hljs-value"><span class="hljs-string">"http://scatedit.episteme.fr/api/protocol/a4977c1f"</span></span>,
       
   125   "<span class="hljs-attribute">prev</span>": <span class="hljs-value"><span class="hljs-string">"null"</span></span>,
       
   126   "<span class="hljs-attribute">results</span>": <span class="hljs-value">[
       
   127     {
       
   128       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"a4977c1f-4752-4aff-b724-eec4033af25c"</span></span>,
       
   129       "<span class="hljs-attribute">owner</span>": <span class="hljs-value"><span class="hljs-string">"group1"</span></span>,
       
   130       "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
       
   131       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Cras rutrum lacinia pretium. Suspendisse justo est, tincidunt sed tellus a, sodales suscipit risus. Curabitur odio tortor, tincidunt sed est nec, ullamcorper sodales velit."</span>
       
   132     </span>}
       
   133   ]
       
   134 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   135   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
   136   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   137   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   138     "<span class="hljs-attribute">count</span>": <span class="hljs-value">{
       
   139       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   140     </span>}</span>,
       
   141     "<span class="hljs-attribute">next</span>": <span class="hljs-value">{
       
   142       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
       
   143       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"4752-4aff-b724-eec4033af25c?page=2"</span>
       
   144     </span>}</span>,
       
   145     "<span class="hljs-attribute">prev</span>": <span class="hljs-value">{
       
   146       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   147     </span>}</span>,
       
   148     "<span class="hljs-attribute">results</span>": <span class="hljs-value">{
       
   149       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span>
       
   150     </span>}
       
   151   </span>}
       
   152 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’utilisateur (application) n’est pas le propriétaire du protocole.</p>
       
   153 </div><h5>Body</h5><pre><code>{
       
   154   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Application is not protocol owner."</span>
       
   155 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   156   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   157   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   158     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   159       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   160     </span>}
       
   161   </span>}</span>,
       
   162   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   163 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’identifiant ne coreespond à aucun protocole.</p>
       
   164 </div><h5>Body</h5><pre><code>{
       
   165   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Object not found."</span>
       
   166 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   167   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   168   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   169     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   170       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   171     </span>}
       
   172   </span>}</span>,
       
   173   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   174 </span>}</code></pre><div style="height: 1px;"></div></div></div></div><div id="révisions-d-un-protocole.-post" class="action post"><h4 class="action-heading"><div class="name">Créer une nouvelle révision du protocole</div><a href="#révisions-d-un-protocole.-post" class="method post">POST</a><code class="uri">/protocol/{id}/</code></h4><p>Permet de créer une nouvelle révision du protocole.</p>
       
   175 <p>L’attribut <code>revision</code> doit être le dernier numéro de révision du protocole.</p>
       
   176 <p>La liste des métacatégorie doit être complête et remplacera la liste existante sur la révision courante.
       
   177 Tous les attributs d’une metacategories doivent être fournis à part <code>id</code>, <code>revision</code> et <code>base</code>.
       
   178 Les rêgles pour ces derniers sont les suivantes</p>
       
   179 <ul>
       
   180 <li>
       
   181 <p>Si <code>id</code> est présent: l’attribut <code>revision</code> doit être fourni et correspondre à la dernière valeur pour cette méta-catégorie. Si un des attributs a été modifé, une nouvelle révision sera créee.</p>
       
   182 </li>
       
   183 <li>
       
   184 <p>Si <code>id</code> n’est pas présent: 2 possibilités:</p>
       
   185 <ul>
       
   186 <li><code>base</code> est présent: Dans ce cas une nouvelle famille de méta-catégorie est créé prenant pour base la métacatégorie dont l’ID est passé comme base. Si les attributs ne sont pas les mêmes, une nouvelle révision sera automatiquement créée, sinon, les attributs de la méta-catégorie de base sont copié dans une révision de base.</li>
       
   187 <li><code>base</code> n’est pas présent: une nouvelle métacatégorie est créée ainsi qu’une nouvelle famille de méta-catégorie basée dessus.</li>
       
   188 </ul>
       
   189 </li>
       
   190 </ul>
       
   191 <p>Dans tous les cas, le retours est une sérialisation complête du protocole d’annotation, avec les nouveaux <code>id</code> et <code>revision</code> pour les méta-catégories créées ou mis à jour.</p>
       
   192 <h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/<span class="hljs-attribute" title="id">a4977c1f-4752-4aff-b724-eec4033af25c</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>id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>a4977c1f-4752-4aff-b724-eec4033af25c</span></span><p>Identifiant d’un protocole</p>
       
   193 </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">Authorization</span>: <span class="hljs-string">Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
       
   194   "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"a4977c1f-4752-4aff-b724-eec4033af25c"</span></span>,
       
   195   "<span class="hljs-attribute">owner</span>": <span class="hljs-value"><span class="hljs-string">"group1"</span></span>,
       
   196   "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
       
   197   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Cras rutrum lacinia pretium. Suspendisse justo est, tincidunt sed tellus a, sodales suscipit risus. Curabitur odio tortor, tincidunt sed est nec, ullamcorper sodales velit."</span></span>,
       
   198   "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">[
       
   199     {
       
   200       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   201       "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   202       "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   203       "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   204       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   205       "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   206       "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
       
   207     </span>}
       
   208   ]
       
   209 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   210   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
   211   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   212   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   213     "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
   214       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   215     </span>}</span>,
       
   216     "<span class="hljs-attribute">owner</span>": <span class="hljs-value">{
       
   217       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   218     </span>}</span>,
       
   219     "<span class="hljs-attribute">revision</span>": <span class="hljs-value">{
       
   220       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   221     </span>}</span>,
       
   222     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
   223       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   224     </span>}</span>,
       
   225     "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">{
       
   226       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span>
       
   227     </span>}
       
   228   </span>}
       
   229 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>201</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>{
       
   230   "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   231   "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   232   "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   233   "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   234   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   235   "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   236   "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
       
   237   "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">[
       
   238     {
       
   239       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   240       "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   241       "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   242       "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   243       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   244       "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   245       "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
       
   246     </span>}
       
   247   ]
       
   248 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   249   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
   250   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   251   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   252     "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
   253       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   254     </span>}</span>,
       
   255     "<span class="hljs-attribute">revision</span>": <span class="hljs-value">{
       
   256       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
   257     </span>}</span>,
       
   258     "<span class="hljs-attribute">base</span>": <span class="hljs-value">{
       
   259       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   260     </span>}</span>,
       
   261     "<span class="hljs-attribute">name</span>": <span class="hljs-value">{
       
   262       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   263     </span>}</span>,
       
   264     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
   265       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   266     </span>}</span>,
       
   267     "<span class="hljs-attribute">color</span>": <span class="hljs-value">{
       
   268       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   269     </span>}</span>,
       
   270     "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value">{
       
   271       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"boolean"</span>
       
   272     </span>}</span>,
       
   273     "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">{
       
   274       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span>
       
   275     </span>}
       
   276   </span>}
       
   277 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’utilisateur (application) n’est pas le propriétaire du protocole.</p>
       
   278 </div><h5>Body</h5><pre><code>{
       
   279   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Application is not protocol owner."</span>
       
   280 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   281   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   282   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   283     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   284       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   285     </span>}
       
   286   </span>}</span>,
       
   287   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   288 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>409</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>Retournée si la valeur de l’attribut <code>revision</code> n’est pas le numéro de version courant du protocole, ou bien d’une des méta-catégories.</p>
       
   289 </div><h5>Body</h5><pre><code>{
       
   290   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Bad revision number."</span>
       
   291 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   292   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   293   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   294     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   295       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   296     </span>}
       
   297   </span>}</span>,
       
   298   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   299 </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="détail-d-un-protocole" class="resource"><h3 class="resource-heading">Détail d'un protocole <a href="#détail-d-un-protocole" class="permalink">&nbsp;&para;</a></h3><div id="détail-d-un-protocole-get" class="action get"><h4 class="action-heading"><div class="name">Voir une revision d'un protocole</div><a href="#détail-d-un-protocole-get" class="method get">GET</a><code class="uri">/protocol/{id}/{revision}/</code></h4><p>Permet d’obtenir la représentation complète d’une révision de protocole.</p>
       
   300 <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/<span class="hljs-attribute" title="id">a4977c1f-4752-4aff-b724-eec4033af25c</span>/<span class="hljs-attribute" title="revision">2</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>id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>a4977c1f-4752-4aff-b724-eec4033af25c</span></span><p>Identifiant d’un protocole</p>
       
   301 </dd><dt>revision</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>2</span></span><p>Numéro de la révision</p>
       
   302 </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<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>{
       
   303   "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   304   "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   305   "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   306   "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   307   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   308   "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   309   "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
       
   310   "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">[
       
   311     {
       
   312       "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   313       "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   314       "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   315       "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   316       "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   317       "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   318       "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
       
   319     </span>}
       
   320   ]
       
   321 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   322   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
   323   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   324   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   325     "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
   326       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   327     </span>}</span>,
       
   328     "<span class="hljs-attribute">revision</span>": <span class="hljs-value">{
       
   329       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
   330     </span>}</span>,
       
   331     "<span class="hljs-attribute">base</span>": <span class="hljs-value">{
       
   332       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   333     </span>}</span>,
       
   334     "<span class="hljs-attribute">name</span>": <span class="hljs-value">{
       
   335       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   336     </span>}</span>,
       
   337     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
   338       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   339     </span>}</span>,
       
   340     "<span class="hljs-attribute">color</span>": <span class="hljs-value">{
       
   341       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   342     </span>}</span>,
       
   343     "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value">{
       
   344       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"boolean"</span>
       
   345     </span>}</span>,
       
   346     "<span class="hljs-attribute">metacategories</span>": <span class="hljs-value">{
       
   347       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"array"</span>
       
   348     </span>}
       
   349   </span>}
       
   350 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’utilisateur (application) n’est pas le propriétaire du protocole.</p>
       
   351 </div><h5>Body</h5><pre><code>{
       
   352   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Application is not protocol owner."</span>
       
   353 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   354   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   355   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   356     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   357       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   358     </span>}
       
   359   </span>}</span>,
       
   360   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   361 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’un des paramêtre est érroné et qu’aucun objet ne correspond.</p>
       
   362 </div><h5>Body</h5><pre><code>{
       
   363   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Object not found."</span>
       
   364 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   365   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   366   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   367     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   368       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   369     </span>}
       
   370   </span>}</span>,
       
   371   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   372 </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="détail-méta-catégorie" class="resource"><h3 class="resource-heading">Détail méta-catégorie <a href="#détail-méta-catégorie" class="permalink">&nbsp;&para;</a></h3><div id="détail-méta-catégorie-get" class="action get"><h4 class="action-heading"><div class="name">Voir le détail d'une méta-catégorie</div><a href="#détail-méta-catégorie-get" class="method get">GET</a><code class="uri">/protocol/{protocol_id}/{revision}/metacategory/{metacategory_id}/</code></h4><p>Permet d’obtenir la représentation d’une révision de métacatégorie.</p>
       
   373 <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/protocol/<span class="hljs-attribute" title="protocol_id">a4977c1f-4752-4aff-b724-eec4033af25c</span>/<span class="hljs-attribute" title="revision">2</span>/metacategory/<span class="hljs-attribute" title="metacategory_id">e5712a76-857a-4769-b27e-a3ac3fb38b4d</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>protocol_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>a4977c1f-4752-4aff-b724-eec4033af25c</span></span><p>Identifiant d’un protocole</p>
       
   374 </dd><dt>revision</dt><dd><code>number</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>2</span></span><p>Numéro de la révision</p>
       
   375 </dd><dt>metacategory_id</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>e5712a76-857a-4769-b27e-a3ac3fb38b4d</span></span><p>Identifiant d’une méta-categorie</p>
       
   376 </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<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>{
       
   377   "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"e5712a76-857a-4769-b27e-a3ac3fb38b4d"</span></span>,
       
   378   "<span class="hljs-attribute">revision</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
       
   379   "<span class="hljs-attribute">base</span>": <span class="hljs-value"><span class="hljs-string">"ef14bcce-52ac-44ba-a7d1-f1441bab94de"</span></span>,
       
   380   "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"référence"</span></span>,
       
   381   "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam."</span></span>,
       
   382   "<span class="hljs-attribute">color</span>": <span class="hljs-value"><span class="hljs-string">"#2cbfff"</span></span>,
       
   383   "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
       
   384 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   385   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span></span>,
       
   386   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   387   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   388     "<span class="hljs-attribute">id</span>": <span class="hljs-value">{
       
   389       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   390     </span>}</span>,
       
   391     "<span class="hljs-attribute">revision</span>": <span class="hljs-value">{
       
   392       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span>
       
   393     </span>}</span>,
       
   394     "<span class="hljs-attribute">base</span>": <span class="hljs-value">{
       
   395       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   396     </span>}</span>,
       
   397     "<span class="hljs-attribute">name</span>": <span class="hljs-value">{
       
   398       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   399     </span>}</span>,
       
   400     "<span class="hljs-attribute">description</span>": <span class="hljs-value">{
       
   401       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   402     </span>}</span>,
       
   403     "<span class="hljs-attribute">color</span>": <span class="hljs-value">{
       
   404       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   405     </span>}</span>,
       
   406     "<span class="hljs-attribute">has_comment</span>": <span class="hljs-value">{
       
   407       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"boolean"</span>
       
   408     </span>}
       
   409   </span>}
       
   410 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’utilisateur (application) n’est pas le propriétaire du protocole.</p>
       
   411 </div><h5>Body</h5><pre><code>{
       
   412   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Application is not protocol owner."</span>
       
   413 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   414   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   415   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   416     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   417       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   418     </span>}
       
   419   </span>}</span>,
       
   420   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   421 </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<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>Retournée si l’un des paramêtre est érroné et qu’aucun objet ne correspond.</p>
       
   422 </div><h5>Body</h5><pre><code>{
       
   423   "<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"Object not found."</span>
       
   424 </span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
       
   425   "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
       
   426   "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
       
   427     "<span class="hljs-attribute">error</span>": <span class="hljs-value">{
       
   428       "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span>
       
   429     </span>}
       
   430   </span>}</span>,
       
   431   "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-04/schema#"</span>
       
   432 </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 16 Jul 2017</p><script>/* eslint-env browser */
       
   433 /* eslint quotes: [2, "single"] */
       
   434 'use strict';
       
   435 
       
   436 /*
       
   437   Determine if a string ends with another string.
       
   438 */
       
   439 function endsWith(str, suffix) {
       
   440     return str.indexOf(suffix, str.length - suffix.length) !== -1;
       
   441 }
       
   442 
       
   443 /*
       
   444   Get a list of direct child elements by class name.
       
   445 */
       
   446 function childrenByClass(element, name) {
       
   447   var filtered = [];
       
   448 
       
   449   for (var i = 0; i < element.children.length; i++) {
       
   450     var child = element.children[i];
       
   451     var classNames = child.className.split(' ');
       
   452     if (classNames.indexOf(name) !== -1) {
       
   453       filtered.push(child);
       
   454     }
       
   455   }
       
   456 
       
   457   return filtered;
       
   458 }
       
   459 
       
   460 /*
       
   461   Get an array [width, height] of the window.
       
   462 */
       
   463 function getWindowDimensions() {
       
   464   var w = window,
       
   465       d = document,
       
   466       e = d.documentElement,
       
   467       g = d.body,
       
   468       x = w.innerWidth || e.clientWidth || g.clientWidth,
       
   469       y = w.innerHeight || e.clientHeight || g.clientHeight;
       
   470 
       
   471   return [x, y];
       
   472 }
       
   473 
       
   474 /*
       
   475   Collapse or show a request/response example.
       
   476 */
       
   477 function toggleCollapseButton(event) {
       
   478     var button = event.target.parentNode;
       
   479     var content = button.parentNode.nextSibling;
       
   480     var inner = content.children[0];
       
   481 
       
   482     if (button.className.indexOf('collapse-button') === -1) {
       
   483       // Clicked without hitting the right element?
       
   484       return;
       
   485     }
       
   486 
       
   487     if (content.style.maxHeight && content.style.maxHeight !== '0px') {
       
   488         // Currently showing, so let's hide it
       
   489         button.className = 'collapse-button';
       
   490         content.style.maxHeight = '0px';
       
   491     } else {
       
   492         // Currently hidden, so let's show it
       
   493         button.className = 'collapse-button show';
       
   494         content.style.maxHeight = inner.offsetHeight + 12 + 'px';
       
   495     }
       
   496 }
       
   497 
       
   498 function toggleTabButton(event) {
       
   499     var i, index;
       
   500     var button = event.target;
       
   501 
       
   502     // Get index of the current button.
       
   503     var buttons = childrenByClass(button.parentNode, 'tab-button');
       
   504     for (i = 0; i < buttons.length; i++) {
       
   505         if (buttons[i] === button) {
       
   506             index = i;
       
   507             button.className = 'tab-button active';
       
   508         } else {
       
   509             buttons[i].className = 'tab-button';
       
   510         }
       
   511     }
       
   512 
       
   513     // Hide other tabs and show this one.
       
   514     var tabs = childrenByClass(button.parentNode.parentNode, 'tab');
       
   515     for (i = 0; i < tabs.length; i++) {
       
   516         if (i === index) {
       
   517             tabs[i].style.display = 'block';
       
   518         } else {
       
   519             tabs[i].style.display = 'none';
       
   520         }
       
   521     }
       
   522 }
       
   523 
       
   524 /*
       
   525   Collapse or show a navigation menu. It will not be hidden unless it
       
   526   is currently selected or `force` has been passed.
       
   527 */
       
   528 function toggleCollapseNav(event, force) {
       
   529     var heading = event.target.parentNode;
       
   530     var content = heading.nextSibling;
       
   531     var inner = content.children[0];
       
   532 
       
   533     if (heading.className.indexOf('heading') === -1) {
       
   534       // Clicked without hitting the right element?
       
   535       return;
       
   536     }
       
   537 
       
   538     if (content.style.maxHeight && content.style.maxHeight !== '0px') {
       
   539       // Currently showing, so let's hide it, but only if this nav item
       
   540       // is already selected. This prevents newly selected items from
       
   541       // collapsing in an annoying fashion.
       
   542       if (force || window.location.hash && endsWith(event.target.href, window.location.hash)) {
       
   543         content.style.maxHeight = '0px';
       
   544       }
       
   545     } else {
       
   546       // Currently hidden, so let's show it
       
   547       content.style.maxHeight = inner.offsetHeight + 12 + 'px';
       
   548     }
       
   549 }
       
   550 
       
   551 /*
       
   552   Refresh the page after a live update from the server. This only
       
   553   works in live preview mode (using the `--server` parameter).
       
   554 */
       
   555 function refresh(body) {
       
   556     document.querySelector('body').className = 'preload';
       
   557     document.body.innerHTML = body;
       
   558 
       
   559     // Re-initialize the page
       
   560     init();
       
   561     autoCollapse();
       
   562 
       
   563     document.querySelector('body').className = '';
       
   564 }
       
   565 
       
   566 /*
       
   567   Determine which navigation items should be auto-collapsed to show as many
       
   568   as possible on the screen, based on the current window height. This also
       
   569   collapses them.
       
   570 */
       
   571 function autoCollapse() {
       
   572   var windowHeight = getWindowDimensions()[1];
       
   573   var itemsHeight = 64; /* Account for some padding */
       
   574   var itemsArray = Array.prototype.slice.call(
       
   575     document.querySelectorAll('nav .resource-group .heading'));
       
   576 
       
   577   // Get the total height of the navigation items
       
   578   itemsArray.forEach(function (item) {
       
   579     itemsHeight += item.parentNode.offsetHeight;
       
   580   });
       
   581 
       
   582   // Should we auto-collapse any nav items? Try to find the smallest item
       
   583   // that can be collapsed to show all items on the screen. If not possible,
       
   584   // then collapse the largest item and do it again. First, sort the items
       
   585   // by height from smallest to largest.
       
   586   var sortedItems = itemsArray.sort(function (a, b) {
       
   587     return a.parentNode.offsetHeight - b.parentNode.offsetHeight;
       
   588   });
       
   589 
       
   590   while (sortedItems.length && itemsHeight > windowHeight) {
       
   591     for (var i = 0; i < sortedItems.length; i++) {
       
   592       // Will collapsing this item help?
       
   593       var itemHeight = sortedItems[i].nextSibling.offsetHeight;
       
   594       if ((itemsHeight - itemHeight <= windowHeight) || i === sortedItems.length - 1) {
       
   595         // It will, so let's collapse it, remove its content height from
       
   596         // our total and then remove it from our list of candidates
       
   597         // that can be collapsed.
       
   598         itemsHeight -= itemHeight;
       
   599         toggleCollapseNav({target: sortedItems[i].children[0]}, true);
       
   600         sortedItems.splice(i, 1);
       
   601         break;
       
   602       }
       
   603     }
       
   604   }
       
   605 }
       
   606 
       
   607 /*
       
   608   Initialize the interactive functionality of the page.
       
   609 */
       
   610 function init() {
       
   611     var i, j;
       
   612 
       
   613     // Make collapse buttons clickable
       
   614     var buttons = document.querySelectorAll('.collapse-button');
       
   615     for (i = 0; i < buttons.length; i++) {
       
   616         buttons[i].onclick = toggleCollapseButton;
       
   617 
       
   618         // Show by default? Then toggle now.
       
   619         if (buttons[i].className.indexOf('show') !== -1) {
       
   620             toggleCollapseButton({target: buttons[i].children[0]});
       
   621         }
       
   622     }
       
   623 
       
   624     var responseCodes = document.querySelectorAll('.example-names');
       
   625     for (i = 0; i < responseCodes.length; i++) {
       
   626         var tabButtons = childrenByClass(responseCodes[i], 'tab-button');
       
   627         for (j = 0; j < tabButtons.length; j++) {
       
   628             tabButtons[j].onclick = toggleTabButton;
       
   629 
       
   630             // Show by default?
       
   631             if (j === 0) {
       
   632                 toggleTabButton({target: tabButtons[j]});
       
   633             }
       
   634         }
       
   635     }
       
   636 
       
   637     // Make nav items clickable to collapse/expand their content.
       
   638     var navItems = document.querySelectorAll('nav .resource-group .heading');
       
   639     for (i = 0; i < navItems.length; i++) {
       
   640         navItems[i].onclick = toggleCollapseNav;
       
   641 
       
   642         // Show all by default
       
   643         toggleCollapseNav({target: navItems[i].children[0]});
       
   644     }
       
   645 }
       
   646 
       
   647 // Initial call to set up buttons
       
   648 init();
       
   649 
       
   650 window.onload = function () {
       
   651     autoCollapse();
       
   652     // Remove the `preload` class to enable animations
       
   653     document.querySelector('body').className = '';
       
   654 };
       
   655 </script></body></html>