-
Notifications
You must be signed in to change notification settings - Fork 2
/
documentation.html
277 lines (268 loc) · 13.2 KB
/
documentation.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!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>
</div>
</div><!-- end #breadcrumbs -->
<div class="content">
<h1 id="title">API PMSIpilot</h1>
<p>
Les API PMSIpilot utilisent le protocole <a href="http://fr.wikipedia.org/wiki/Hypertext_Transfer_Protocol" title="HTTP">HTTP</a> basé sur des <a title="Spécification des requêtes" href="specification-requetes.html">requêtes</a> et des <a title="Spécification des réponses" href="specification-reponses.html">réponses</a>.<br />
</p>
<p>
Vous pouvez accéder à des <a href="exemple-sejour-type.html">exemples de scénarios</a>.
</p>
<h2>Liste des API <strong>temps-réel</strong></h2>
<div class="span16">
<table class="views-table">
<caption>
<strong>Identités</strong>
<p>Informations en temps-réel sur les <a href="structure-identite.html" title="Structure des identités">identités</a>.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="identites.html#recuperation-liste-identites">GET api/identites</a></td>
<td class="views-field-body">Retourne la liste des identités.</td>
</tr>
<tr>
<td class="views-field-title"><a href="identites.html#recuperation-identite">GET api/identites/:ipp</a></td>
<td class="views-field-body">Retourne l'identité identifiée par <code>:ipp</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="identites.html#ajout-identite">POST api/identites</a></td>
<td class="views-field-body">Ajoute une identité.</td>
</tr>
<tr>
<td class="views-field-title"><a href="identites.html#modification-identite">PUT api/identites/:ipp</a></td>
<td class="views-field-body">Modifie l'identité identifiée par <code>:ipp</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="identites.html#suppression-identite">DELETE api/identites/:ipp</a></td>
<td class="views-field-body">Supprime l'identité identifiée par <code>:ipp</code>.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Fusions</strong>
<p>Informations en temps-réel sur les <a href="structure-fusion.html" title="Structure des fusions">fusions</a> d'<a href="structure-identite.html" title="Structure des identités">identités</a>. Il est impossible de modifier ou supprimer une fusion.
</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="fusions.html#recuperation-liste-fusion">GET api/fusions</a></td>
<td class="views-field-body">Retourne la liste des fusions.</td>
</tr>
<tr>
<td class="views-field-title"><a href="fusions.html#recuperation-fusion">GET api/fusions/:ipf</a></td>
<td class="views-field-body">Retourne la fusion identifiée par <code>:ipf</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="fusions.html#ajout-fusion">POST api/fusions</a></td>
<td class="views-field-body">Ajoute une fusion.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Séjours</strong>
<p>Informations en temps-réel sur les <a href="structure-sejour.html" title="Structure des séjours">séjours</a>.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="sejours.html#recuperation-liste-séjours">GET api/sejours</a></td>
<td class="views-field-body">Retourne la liste des séjours.</td>
</tr>
<tr>
<td class="views-field-title"><a href="sejours.html#recuperation-liste-séjours-identite">GET api/identites/:ipp/sejours</a></td>
<td class="views-field-body">Retourne la liste des séjours de l'identité identifiée par <code>:ipp</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="sejours.html#recuperation-sejour">GET api/sejours/:iep</a></td>
<td class="views-field-body">Retourne le séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="sejours.html#ajout-sejour">POST api/identites/:ipp/sejours</a></td>
<td class="views-field-body">Ajoute un séjour à l'identité identifiée par <code>:ipp</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="sejours.html#modification-sejour">PUT api/sejours/:iep</a></td>
<td class="views-field-body">Modifie le séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="sejours.html#suppression-sejour">DELETE api/sejours/:iep</a></td>
<td class="views-field-body">Supprime le séjour identifié par <code>:iep</code>.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Mouvements</strong>
<p>Informations en temps-réel sur les <a href="structure-mouvement.html" title="Structure des mouvements">mouvements</a> durant un <a href="structure-sejour.html" title="Structure des séjours">séjour</a>.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="mouvements.html">GET api/mouvements</a></td>
<td class="views-field-body">Retourne la liste des mouvements.</td>
</tr>
<tr>
<td class="views-field-title"><a href="mouvements.html">GET api/sejours/:iep/mouvements</a></td>
<td class="views-field-body">Retourne la liste des mouvements d'un séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="mouvements.html">GET api/sejours/:iep/mouvements/:numero</a></td>
<td class="views-field-body">Retourne le mouvement <code>:numero</code>, du séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="mouvements.html">POST api/sejours/:iep/mouvements</a></td>
<td class="views-field-body">Ajoute un mouvement au séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="mouvements.html">PUT api/sejours/:iep/mouvements/:numero</a></td>
<td class="views-field-body">Modifie le mouvement <code>:numero</code>, du séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="mouvements.html">DELETE api/sejours/:iep/mouvements/:numero</a></td>
<td class="views-field-body">Supprime le mouvement <code>:numero</code>, du séjour identifié par <code>:iep</code>.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Permissions</strong>
<p>Informations en temps-réel sur les <a href="structure-permission.html" title="Structure des permissions">permissions</a> effectuées durant un <a href="structure-sejour.html" title="Structure des séjours">séjour</a>.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="permissions.html">GET api/permissions</a></td>
<td class="views-field-body">Retourne la liste des permissions.</td>
</tr>
<tr>
<td class="views-field-title"><a href="permissions.html">GET api/sejours/:iep/permissions</a></td>
<td class="views-field-body">Retourne la liste des permissions d'un séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="permissions.html">GET api/permissions/:ipe</a></td>
<td class="views-field-body">Retourne le permission identifiée par <code>:ipe</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="permissions.html">PUT api/permissions/:ipe</a></td>
<td class="views-field-body">Modifie le permission identifiée par <code>:ipe</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="permissions.html">DELETE api/permissions/:ipe</a></td>
<td class="views-field-body">Supprime le permission identifiée par <code>:ipe</code>.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Actes</strong>
<p>Informations en temps-réel sur les <a href="structure-acte.html" title="Structure des actes">actes</a> réalisés durant un <a href="structure-sejour.html" title="Structure des séjours">séjour</a>.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="actes.html#recuperation-liste-actes">GET api/actes</a></td>
<td class="views-field-body">Retourne la liste des actes.</td>
</tr>
<tr>
<td class="views-field-title"><a href="actes.html#recuperation-liste-actes-sejour">GET api/sejours/:iep/actes</a></td>
<td class="views-field-body">Retourne la liste des actes d'un séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="actes.html#recuperation-acte">GET api/actes/:ipa</a></td>
<td class="views-field-body">Retourne l'acte identifié par <code>:ipa</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="actes.html#ajout-acte">POST api/sejours/:iep/actes</a></td>
<td class="views-field-body">Ajoute un acte au séjour identifié par <code>:iep</code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="actes.html#modification-acte">PUT api/actes/:ipa</a></td>
<td class="views-field-body">Modifie l'acte identifié par <code>:ipa</code></code>.</td>
</tr>
<tr>
<td class="views-field-title"><a href="actes.html#suppression-acte">DELETE api/actes/:ipa</a></td>
<td class="views-field-body">Supprime l'acte identifié par <code>:ipa</code>.</td>
</tr>
</tbody>
</table>
<table class="views-table">
<caption>
<strong>Suppressions</strong>
<p>Informations en temps-réel sur les suppressions de données.</p>
</caption>
<thead>
<tr>
<th class="views-field-title">Resource</th>
<th class="views-field-body">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="views-field-title"><a href="suppressions.html#recuperation-liste-suppressions">GET api/suppressions</a></td>
<td class="views-field-body">Retourne la liste des éléments supprimés.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div> <!-- /container -->
</body>
</html>