Blame view

api.raml 17.4 KB
90a48e21   Geoffrey PREUD'HOMME   Personnes
1
  #%RAML 0.8
ea2f57e1   Geoffrey PREUD'HOMME   Test API
2
3
4
  title: API d'Etunicorn
  baseUri: https://etunicorn.plil.net/{version}/
  version: v1
90a48e21   Geoffrey PREUD'HOMME   Personnes
5
  
153931ca   Geoffrey PREUD'HOMME   Benoît, apprend à...
6
7
  securitySchemes:
      - oauth_2_0:
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
8
          settings:
153931ca   Geoffrey PREUD'HOMME   Benoît, apprend à...
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
          description: Il faut un token OAuth 2.0 pour utiliser cette API
          type: OAuth 2.0
          describedBy:
              headers:
                  Authorization:
                      description: |
                         Utilisé pour envoyer un token d'accès OAuth 2. Ne pas envoyer en même temps que le paramètre de requête "access_token"
                      type: string
              queryParameters:
                  access_token:
                      description: |
                         Utilisé pour envoyer un token d'accès OAuth 2. Ne pas envoyer en même temps que le header "Authorization"
                      type: string
              responses:
                  401:
                      description: Token expiré ou invalide. Reconnectez-vous
                  403:
                      description: Permission refusée. Se re-connecter ne changera rien
  
  # Les codes 400 sont implicites
509e1d6e   Geoffrey PREUD'HOMME   API: Login
29
  /login:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
30
31
    post:
      description: Instancie une nouvelle connexion
90a48e21   Geoffrey PREUD'HOMME   Personnes
32
      queryParameters:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
33
34
35
36
37
38
39
40
        login:
          displayName: Login Polytech
          type: string
          required: true
        password:
          displayName: Mot de passe Polytech
          type: string
          required: false
e9bf0f84   badetitou   Evenement
41
      responses:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
42
43
44
45
        200:
          description: Authentification réussie
          body:
            application/json:
90a48e21   Geoffrey PREUD'HOMME   Personnes
46
              example: |
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
47
48
                {
                  "token": "ooT6zahdura7vaethuiph1ugiph6co",
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
49
50
51
52
                  "expire": 1485607703,
                  "role": "admin",
                  "permissions": [
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
53
                      "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
54
55
                    },
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
56
                      "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
57
58
                    }
                  ]
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
59
60
61
                }
        401:
          description: Authentication échouée
90a48e21   Geoffrey PREUD'HOMME   Personnes
62
63
64
    /{token}:
      delete:
        description: Se déconnecter
e9bf0f84   badetitou   Evenement
65
        responses:
90a48e21   Geoffrey PREUD'HOMME   Personnes
66
67
68
          204:
            description: Déconnecté avec succès
          404:
7fa0cd71   badetitou   Les Transactions
69
            description: Jeton non trouvé
ea2f57e1   Geoffrey PREUD'HOMME   Test API
70
  /personne:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
71
    get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
72
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
73
74
      description: Obtenir la liste des persones. Nécessite COMPTE_ADMIN
      responses:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
75
76
        200:
          body:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
77
            application/json:
90a48e21   Geoffrey PREUD'HOMME   Personnes
78
              example: |
509e1d6e   Geoffrey PREUD'HOMME   API: Login
79
                [
90a48e21   Geoffrey PREUD'HOMME   Personnes
80
81
82
                 {
                    "id": 42,
                    "carte": "AAAAA",
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
83
                    "naissance": "855874800000",
509e1d6e   Geoffrey PREUD'HOMME   API: Login
84
                    "solde": 1337,
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
85
86
                    "login": "gbontoux",
                    "role": "etudiant"
509e1d6e   Geoffrey PREUD'HOMME   API: Login
87
88
                  }
                ]
90a48e21   Geoffrey PREUD'HOMME   Personnes
89
    /{idPersonne}:
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
90
91
92
93
94
95
      uriParameters:
        idPersonne:
          type: number
          required: true
          description: ID de la personne
          minimum: 0
90a48e21   Geoffrey PREUD'HOMME   Personnes
96
      get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
97
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
98
        description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
99
100
101
102
103
104
105
106
107
        responses:
          200:
            description: Utilisateur récupéré
            body:
              application/json:
                example: |
                 {
                    "id": 42,
                    "carte": "AAAAA",
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
108
                    "naissance": "855874800000",
90a48e21   Geoffrey PREUD'HOMME   Personnes
109
                    "solde": 1337,
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
110
111
                    "login": "gbontoux",
                    "role": "etudiant"
90a48e21   Geoffrey PREUD'HOMME   Personnes
112
113
114
115
                  }
          404:
            description: Utilisateur non trouvé
      put:
464d0189   Geoffrey PREUD'HOMME   Sécurité
116
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
117
        description: Modifer les infos d'une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
118
119
120
121
122
123
124
125
126
127
128
        queryParameters:
          carte:
            displayName: ID de la carte NFC
            type: string
            required: false
            minLength: 14
            maxLength: 14
            example: 39cdd9ed0b191d
          naissance:
            displayName: Date de naissance
            type: date
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
129
            example: "14-Feb-1997"
90a48e21   Geoffrey PREUD'HOMME   Personnes
130
131
132
133
134
135
136
            required: false
            example: 1997-02-14
          login:
            displayName: Login Polytech
            type: string
            required: false
            example: gbontoux
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
137
138
          role:
            displayName: Rôle
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
139
            description: Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
140
141
142
            type: string
            required: false
            example: etudiant
90a48e21   Geoffrey PREUD'HOMME   Personnes
143
144
145
        responses:
          202:
            description: Utilisateur modifié
90a48e21   Geoffrey PREUD'HOMME   Personnes
146
147
148
          404:
            description: Utilisateur non trouvé
      delete:
464d0189   Geoffrey PREUD'HOMME   Sécurité
149
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
150
        description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
151
152
153
154
155
156
        responses:
          204:
            description: Utilisateur supprimé
          404:
            description: Utilisateur non trouvé
    post:
90a48e21   Geoffrey PREUD'HOMME   Personnes
157
      description: Ajoute une nouvelle personne
509e1d6e   Geoffrey PREUD'HOMME   API: Login
158
      queryParameters:
90a48e21   Geoffrey PREUD'HOMME   Personnes
159
        carte:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
160
161
162
          displayName: ID de la carte NFC
          type: string
          required: false
90a48e21   Geoffrey PREUD'HOMME   Personnes
163
164
165
          minLength: 14
          maxLength: 14
          example: 39cdd9ed0b191d
509e1d6e   Geoffrey PREUD'HOMME   API: Login
166
167
        naissance:
          displayName: Date de naissance
90a48e21   Geoffrey PREUD'HOMME   Personnes
168
169
170
171
172
173
174
175
          type: date
          required: false
          example: 1997-02-14
        login:
          displayName: Login Polytech
          type: string
          required: false
          example: gbontoux
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
176
177
        role:
          displayName: Rôle
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
178
          description: Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
179
          type: string
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
180
          required: false
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
181
182
          example: etudiant
          default: etudiant
e9bf0f84   badetitou   Evenement
183
      responses:
90a48e21   Geoffrey PREUD'HOMME   Personnes
184
185
186
187
188
189
190
191
        201:
          description: Personne ajoutée avec succès
          body:
            application/json:
              example: |
                {
                  "id": 42
                }
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
192
193
  /role:
    get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
194
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
195
      description: Liste les rôles. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
196
      responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
197
        200:
e9bf0f84   badetitou   Evenement
198
          body:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
199
200
201
202
203
204
205
206
207
208
209
            application/json:
              example: |
                [
                  {
                    "nom": "etudiant",
                    "permissions": []
                  },
                  {
                    "nom": "bde",
                      "permissions": [
                      {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
210
                        "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
211
212
                      },
                      {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
213
                        "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
214
215
216
217
218
                      }
                    ]
                  }
                ]
    post:
464d0189   Geoffrey PREUD'HOMME   Sécurité
219
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
220
      description: Ajoute un nouveau rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
221
      queryParameters:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
222
223
224
225
226
        nom:
          type: string
          minLength: 3
          required: true
          example: bde
e9bf0f84   badetitou   Evenement
227
      responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
228
229
230
231
232
233
        201:
          description: Rôle créé avec succès
        409:
          description: Un rôle avec le même nom existe déjà
    /{nomRole}:
      delete:
464d0189   Geoffrey PREUD'HOMME   Sécurité
234
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
235
        description: Supprime un rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
236
        responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
237
238
239
240
241
          204:
            description: Rôle supprimé
          404:
            description: Rôle inconnu
      post:
464d0189   Geoffrey PREUD'HOMME   Sécurité
242
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
243
        description: Ajoute une permission à un rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
244
        queryParameters:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
245
246
247
248
          nom:
            type: string
            required: true
            minLength: 3
e9bf0f84   badetitou   Evenement
249
        responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
250
251
252
253
254
255
          201:
            description: Permission ajouté avec succès
          404:
            description: Permission ou rôle inconnu
      /{nomPermission}:
        delete:
464d0189   Geoffrey PREUD'HOMME   Sécurité
256
          securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
257
          description: Enlève la permission du rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
258
          responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
259
260
261
262
263
264
            204:
              description: Permission enlevée avec succès
            404:
              description: Permission ou rôle inconnu
    /permission:
      get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
265
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
266
        description: Liste les permissions. Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
267
268
269
270
271
272
273
        responses:
          200:
            body:
              application/json:
                example: |
                  [
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
274
                      "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
275
276
                    },
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
277
                      "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
278
279
                    }
                  ]
e9bf0f84   badetitou   Evenement
280
  
ff2fc742   badetitou   untab
281
282
  /evenement:
    get:
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
283
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
284
      description: Obtenir la liste de tout les evenements. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
ff2fc742   badetitou   untab
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
      responses:
        200:
          body:
            application/json:
              example: |
                [
                  {
                    "id": 1,
                    "nomEvenement": "patate",
                    "prix": 4,
                    "date": "2001-09-11"
                  },
                  {
                    "id": 2,
                    "nomEvenement": "patate flambe",
                    "prix": 5,
                    "date": "2001-09-11"
                  }
                ]
    post:
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
305
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
306
      description: Permet de creer un nouvel evenement. Nécessite EVNMT_ADMIN
ff2fc742   badetitou   untab
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
      queryParameters:
        nomEvenement:
          description: Le nom de l'evenement
          type: string
          required: true
        prix:
          description: Le prix de l'evenement
          type: number
          required: true
        date:
          description: La date de l'evenement
          type: date
          required: true
      responses:
        201:
e9bf0f84   badetitou   Evenement
322
  
ff2fc742   badetitou   untab
323
324
    /{evenementId}:
      put:
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
325
        description: Permet de modifier un évènement existant. Nécessite EVNMT_ADMIN
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
326
        securedBy: [oauth_2_0]
ff2fc742   badetitou   untab
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
        queryParameters:
          nomEvenement:
            description: Le nom de l'evenement
            type: string
            required: false
          prix:
            description: Le prix de l'evenement
            type: number
            required: false
          date:
            description: La date de l'evenement
            type: date
            required: false
        responses:
          202:
            description: Modification pris en compte
          404:
            description: L'evenement n'existe pas
      get:
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
346
        securedBy: [oauth_2_0]
1ae1d9d5   badetitou   Ajout de transact...
347
        description: Obtenir l'evenement {evenementId}. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
ff2fc742   badetitou   untab
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
        responses:
          200:
            body:
              application/json:
                example: |
                  [
                     {
                      "id": 1,
                      "nomEvenement": "patate",
                      "prix": 4,
                      "date": "2001-09-11"
                    }
                  ]
          404:
            description: Evenement non existant
      delete:
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
364
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
365
        description: Permet de supprimer l'evenement {evenementId}. Nécessite EVNMT_ADMIN
ff2fc742   badetitou   untab
366
367
368
        responses:
          200:
            description: L'evenement a été bien supprimé
e9bf0f84   badetitou   Evenement
369
370
371
372
  
  
  
  
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
373
  /consommation:
ff2fc742   badetitou   untab
374
    get:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
375
      securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
376
      description: Obtenir la liste de toutes les consommations. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
ff2fc742   badetitou   untab
377
378
379
380
381
382
383
384
      responses:
        200:
          body:
            application/json:
              example: |
                [
                  {
                    "id": 1,
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
385
                    "nomconsommation": "juis de fruit",
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
386
                    "prix": 4
ff2fc742   badetitou   untab
387
388
389
390
                  },
                  {
                    "id": 2,
                    "nomEvenement": "juis de fruit flambe",
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
391
                    "prix": 5
ff2fc742   badetitou   untab
392
393
394
                  }
                ]
    post:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
395
      securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
396
      description: Permet de creer une nouvelle consommation. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
397
      queryParameters:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
398
399
        nomconsommation:
          description: Le nom de la consommation
ff2fc742   badetitou   untab
400
401
402
          type: string
          required: true
        prix:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
403
          description: Le prix de la consommation
ff2fc742   badetitou   untab
404
405
406
407
          type: number
          required: true
      responses:
        201:
e9bf0f84   badetitou   Evenement
408
  
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
409
    /{consommationId}:
ff2fc742   badetitou   untab
410
      put:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
411
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
412
        description: Permet de modifier une consommation. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
413
414
        queryParameters:
          nomEvenement:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
415
            description: Le nom de la consommation
ff2fc742   badetitou   untab
416
417
418
            type: string
            required: false
          prix:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
419
            description: Le prix de la consommation
ff2fc742   badetitou   untab
420
421
422
423
424
425
426
427
            type: number
            required: false
        responses:
          202:
            description: Modification pris en compte
          404:
            description: L'evenement n'existe pas
      get:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
428
        securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
429
        description: Obtenir la consommation {consommationId}. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
ff2fc742   badetitou   untab
430
431
432
433
434
435
436
437
438
439
440
441
442
443
        responses:
          200:
            body:
              application/json:
                example: |
                  [
                     {
                      "id": 1,
                      "nomEvenement": "patate",
                      "prix": 4,
                      "date": "2001-09-11"
                    }
                  ]
          404:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
444
            description: consommation non existante
ff2fc742   badetitou   untab
445
      delete:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
446
        securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
447
        description: Permet de supprimer la consommation {consommationId}. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
448
449
        responses:
          200:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
450
            description: La consommation a été bien supprime
7fa0cd71   badetitou   Les Transactions
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
  /participe:
    post:
      description: Permet d'ajouter une personne a un evenement
      queryParameters:
        idPersonne:
          type: integer
          required: true
          description: l'identifiant unique de l'utilisateur
        idEvenement:
          type: integer
          required: true
          description: l'identifiant unique d'un evenement
      responses:
        201:
          description: La personne est bien inscrite a cet evenement
    get:
      description: Permet de savoir si une personne participe a un evenement
      queryParameters:
        idPersonne:
          type: integer
          required: true
          description: l'identifiant unique de l'utilisateur
        idEvenement:
          type: integer
          required: true
          description: l'identifiant unique d'un evenement
      responses:
        200:
          description: La personne est bien inscrite à l'evenement
        404:
          description: La personne n'est pas inscrite à l'evenement
  
  
  /transaction:
    get:
      description: Permet de recuperer la liste des transaction
      responses:
        200:
          description: On recupere la liste des transactions
          body:
            application/json:
              example: |
                [
                  {
                    "participant": 1,
                    "acteur": 18,
                    "idTransaction": 42,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": 25.23
                  },
                  {
                    "participant": 5,
                    "acteur": 1,
                    "idTransaction": 43,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": -25.23
                  }
                ]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
511
    /consommation:
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
512
513
514
515
516
517
518
519
520
521
      post:
        description: Permet de faire payer ou de crediter un Compte. >0 la personne a crediter de l'argent. <0 la personne a été débité.
        queryParameters:
          participant:
            type: integer
            required: true
            description: L'identifiant de la personne qui utilise son compte
          id:
            type: integer
            required: true
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
522
            description: l'indentification de la consommation qui vient d'être payé
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
523
524
        responses:
          201:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
525
            description: La consommation a été bien payé
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
    /evenement:
      post:
        description:
        queryParameters:
          participant:
            type: integer
            required: true
            description: L'identifiant de la personne qui utilise son compte
          id:
            type: integer
            required: true
            description: l'identifiant de l'evenement
        responses:
          201:
            description: L'evenement a bien été payé
1ae1d9d5   badetitou   Ajout de transact...
541
      /credit:
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
542
        post:
1ae1d9d5   badetitou   Ajout de transact...
543
544
545
546
547
548
          description: Permet de recharger un compte
          queryParameters:
            participant:
              type: integer
              required: true
              description: L'identifiant de la personne crédité
1ae1d9d5   badetitou   Ajout de transact...
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
            prix:
              type: number
              required: true
              description: La valeur credité sur le solde de participant
          responses:
            201:
              description: La personne a bien été crédité
      /debit:
        post:
          description: Permet de debiter la carte
          queryParameters:
            participant:
              type: integer
              required: true
              description: L'identifiant de la personne debité
1ae1d9d5   badetitou   Ajout de transact...
564
565
566
567
568
569
570
            prix:
              type: number
              required: true
              description: La valeur debité sur le solde de participant
          responses:
            201:
              description: La personne a bien été débité
7fa0cd71   badetitou   Les Transactions
571
572
573
574
575
576
577
578
579
580
581
582
583
    /participant/{idPersonne}:
      get:
        description: Permet de recuperer la liste des transaction d'une personne
        responses:
          200:
            description: On recupere la liste des transactions
            body:
              application/json:
                example: |
                  [
                    {
                      "participant": 1,
                      "acteur": 18,
1ae1d9d5   badetitou   Ajout de transact...
584
                      "id": 42,
7fa0cd71   badetitou   Les Transactions
585
586
587
588
589
590
591
                      "type": true,
                      "date": "2003-12-01",
                      "prix": 25.23
                    },
                    {
                      "participant": 1,
                       "acteur": 12,
1ae1d9d5   badetitou   Ajout de transact...
592
                      "id": 43,
7fa0cd71   badetitou   Les Transactions
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
                      "type": true,
                      "date": "2003-12-01",
                      "prix": -25.23
                    }
                  ]
    /acteur/{idPersonne}:
      get:
        description: Permet de recuperer la liste des transaction d'une personne
        responses:
          200:
            description: On recupere la liste des transactions
            body:
              application/json:
                example: |
                  [
                    {
                      "participant": 1,
                      "acteur": 18,
                      "idTransaction": 42,
                      "type": true,
                      "date": "2003-12-01",
                      "prix": 25.23
                    },
                    {
                      "participant": 1,
                      "acteur": 12,
                      "idTransaction": 43,
                      "type": true,
                      "date": "2003-12-01",
                      "prix": -25.23
                    }
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
624
                  ]