-
Notifications
You must be signed in to change notification settings - Fork 2
/
permissions.html
69 lines (63 loc) · 3.92 KB
/
permissions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<!DOCTYPE html>
<html lang="fr">
<head>
<title>API PMSIpilot</title>
<meta charset="utf-8">
<script type="text/javascript" src="js/jquery-1.7.1.min.js"></script>
<script type="text/javascript" src="js/api.js"></script>
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/base.css">
</head>
<body>
<div class="topbar">
<div class="fill">
<div class="container">
<a class="brand" href="index.html">Présentation</a>
<a class="brand" href="documentation.html">Documentation</a>
<a class="brand" href="http://www.pmsipilot.com/fr/contact">Contact</a>
</div>
</div>
</div>
<div class="container">
<div id="breadcrumbs">
<div class="breadcrumb">
<a href="documentation.html">Documentation</a> → <a href="#">API permissions</a>
</div>
</div><!-- end #breadcrumbs -->
<div class="content row">
<div class="span12">
<h1 id="title">API permissions</h1>
<h2 id="recuperation-liste-permissions">Récupération de la liste des permissions</h2>
<pre><strong>GET</strong> api/permissions?token=#{token}</pre>
<p class="request">Si le paramètre <code>token</code> est spécifié, seules les permissions ajoutées ou modifiées depuis ce token seront retournées.</p>
<p class="response">L'API retourne la liste des <a href="structure-permission.html">permissions</a> triées par date de création (les plus anciennes en premier).</p>
<h2 id="recuperation-permission-par-sejour">Récupération de la liste des permissions (d'un séjour)</h2>
<pre><strong>GET</strong> api/sejours/#{iep}/permissions</pre>
<p class="request">Le paramètre <span class="label">obligatoire</span> <code>iep</code> permet de cibler le séjour dont on souhaite obtenir les permissions.</p>
<p class="response">L'API retourne la liste des <a href="structure-permission.html">permissions</a> triées par date de création (les plus anciennes en premier).</p>
<h2 id="recuperation-permission">Récupération d'une permission</h2>
<pre><strong>GET</strong> api/permissions/#{ipe}</pre>
<p class="request">Le paramètre <span class="label">obligatoire</span> <code>ipe</code> permet de cibler la permission à retourner.</p>
<p class="response">L'API retourne un code 200 ("OK") et la <a href="structure-permission.html">permission</a> demandée.</p>
<h2 id="ajout-permission">Ajout d'une permission</h2>
<pre><strong>POST</strong> api/sejours/#{iep}/permissions</pre>
<p class="request">Le paramètre <span class="label">obligatoire</span> <code>iep</code> permet de cibler le séjour dont on souhaite obtenir les permissions.<br/>Une <a href="structure-permission.html">permission</a> doit être passée en paramètre.</p>
<p class="response">L'API retourne un code 201 ("Created").</p>
<h2 id="modification-permission">Modification d'une permission</h2>
<pre><strong>PUT</strong> api/permissions/#{ipe}</pre>
<p class="request">Le paramètre <span class="label">obligatoire</span> <code>ipe</code> permet de cibler la permission à modifier.<br />Une <a href="structure-permission.html">permission</a> doit être passée en paramètre.</p>
<p class="response">L'API retourne un code 204 ("No Content").</p>
<h2 id="suppression-permission">Suppression d'une permission</h2>
<pre><strong>DELETE</strong> api/permissions/#{ipe}</pre>
<p class="request">Le paramètre <span class="label">obligatoire</span> <code>ipe</code> permet de cibler la permission à supprimer.</p>
<p class="response">L'API retourne un code 204 ("No Content").</p>
</div>
<div id="sidebar" class="span5"></div>
</div>
</div> <!-- /container -->
<footer>
</footer>
<script type="text/javascript">window.hijs = '.highlight';</script>
<script type="text/javascript" src="js/hijs.js"></script>
</body>
</html>