Blame view

api.raml 17.5 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:
8f05ee77   Geoffrey PREUD'HOMME   API /role et amél...
9
10
11
            authorizationUri: /oauth2/authorize
            accessTokenUri: /oauth2/token
            authorizationGrants: [ code, token ]
153931ca   Geoffrey PREUD'HOMME   Benoît, apprend à...
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
          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
32
  /login:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
33
34
    post:
      description: Instancie une nouvelle connexion
90a48e21   Geoffrey PREUD'HOMME   Personnes
35
      queryParameters:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
36
37
38
39
40
41
42
43
        login:
          displayName: Login Polytech
          type: string
          required: true
        password:
          displayName: Mot de passe Polytech
          type: string
          required: false
e9bf0f84   badetitou   Evenement
44
      responses:
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
45
46
47
48
        200:
          description: Authentification réussie
          body:
            application/json:
90a48e21   Geoffrey PREUD'HOMME   Personnes
49
              example: |
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
50
51
                {
                  "token": "ooT6zahdura7vaethuiph1ugiph6co",
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
52
53
54
55
                  "expire": 1485607703,
                  "role": "admin",
                  "permissions": [
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
56
                      "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
57
58
                    },
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
59
                      "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
60
61
                    }
                  ]
b8824e3a   Geoffrey PREUD'HOMME   Avec le login, ce...
62
63
64
                }
        401:
          description: Authentication échouée
90a48e21   Geoffrey PREUD'HOMME   Personnes
65
66
67
    /{token}:
      delete:
        description: Se déconnecter
e9bf0f84   badetitou   Evenement
68
        responses:
90a48e21   Geoffrey PREUD'HOMME   Personnes
69
70
71
          204:
            description: Déconnecté avec succès
          404:
7fa0cd71   badetitou   Les Transactions
72
            description: Jeton non trouvé
ea2f57e1   Geoffrey PREUD'HOMME   Test API
73
  /personne:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
74
    get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
75
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
76
77
      description: Obtenir la liste des persones. Nécessite COMPTE_ADMIN
      responses:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
78
79
        200:
          body:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
80
            application/json:
90a48e21   Geoffrey PREUD'HOMME   Personnes
81
              example: |
509e1d6e   Geoffrey PREUD'HOMME   API: Login
82
                [
90a48e21   Geoffrey PREUD'HOMME   Personnes
83
84
85
                 {
                    "id": 42,
                    "carte": "AAAAA",
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
86
                    "naissance": "855874800000",
509e1d6e   Geoffrey PREUD'HOMME   API: Login
87
                    "solde": 1337,
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
88
89
                    "login": "gbontoux",
                    "role": "etudiant"
509e1d6e   Geoffrey PREUD'HOMME   API: Login
90
91
                  }
                ]
90a48e21   Geoffrey PREUD'HOMME   Personnes
92
    /{idPersonne}:
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
93
94
95
96
97
98
      uriParameters:
        idPersonne:
          type: number
          required: true
          description: ID de la personne
          minimum: 0
90a48e21   Geoffrey PREUD'HOMME   Personnes
99
      get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
100
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
101
        description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
102
103
104
105
106
107
108
109
110
        responses:
          200:
            description: Utilisateur récupéré
            body:
              application/json:
                example: |
                 {
                    "id": 42,
                    "carte": "AAAAA",
790d94b4   Geoffrey PREUD'HOMME   Base de données, ...
111
                    "naissance": "855874800000",
90a48e21   Geoffrey PREUD'HOMME   Personnes
112
                    "solde": 1337,
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
113
114
                    "login": "gbontoux",
                    "role": "etudiant"
90a48e21   Geoffrey PREUD'HOMME   Personnes
115
116
117
118
                  }
          404:
            description: Utilisateur non trouvé
      put:
464d0189   Geoffrey PREUD'HOMME   Sécurité
119
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
120
        description: Modifer les infos d'une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
121
122
123
124
125
126
127
128
129
130
131
        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, ...
132
            example: "14-Feb-1997"
90a48e21   Geoffrey PREUD'HOMME   Personnes
133
            required: false
90a48e21   Geoffrey PREUD'HOMME   Personnes
134
135
136
137
138
          login:
            displayName: Login Polytech
            type: string
            required: false
            example: gbontoux
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
139
140
          role:
            displayName: Rôle
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
141
            description: Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
142
143
144
            type: string
            required: false
            example: etudiant
90a48e21   Geoffrey PREUD'HOMME   Personnes
145
146
147
        responses:
          202:
            description: Utilisateur modifié
90a48e21   Geoffrey PREUD'HOMME   Personnes
148
149
150
          404:
            description: Utilisateur non trouvé
      delete:
464d0189   Geoffrey PREUD'HOMME   Sécurité
151
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
152
        description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
90a48e21   Geoffrey PREUD'HOMME   Personnes
153
154
155
156
157
158
        responses:
          204:
            description: Utilisateur supprimé
          404:
            description: Utilisateur non trouvé
    post:
90a48e21   Geoffrey PREUD'HOMME   Personnes
159
      description: Ajoute une nouvelle personne
509e1d6e   Geoffrey PREUD'HOMME   API: Login
160
      queryParameters:
90a48e21   Geoffrey PREUD'HOMME   Personnes
161
        carte:
509e1d6e   Geoffrey PREUD'HOMME   API: Login
162
163
164
          displayName: ID de la carte NFC
          type: string
          required: false
90a48e21   Geoffrey PREUD'HOMME   Personnes
165
166
167
          minLength: 14
          maxLength: 14
          example: 39cdd9ed0b191d
509e1d6e   Geoffrey PREUD'HOMME   API: Login
168
169
        naissance:
          displayName: Date de naissance
90a48e21   Geoffrey PREUD'HOMME   Personnes
170
171
172
173
174
175
176
177
          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
178
179
        role:
          displayName: Rôle
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
180
          description: Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
181
          type: string
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
182
          required: false
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
183
          example: etudiant
e9bf0f84   badetitou   Evenement
184
      responses:
90a48e21   Geoffrey PREUD'HOMME   Personnes
185
186
187
188
189
190
191
192
        201:
          description: Personne ajoutée avec succès
          body:
            application/json:
              example: |
                {
                  "id": 42
                }
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
193
194
  /role:
    get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
195
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
196
      description: Liste les rôles. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
197
      responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
198
        200:
e9bf0f84   badetitou   Evenement
199
          body:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
200
201
202
203
204
205
206
207
208
209
210
            application/json:
              example: |
                [
                  {
                    "nom": "etudiant",
                    "permissions": []
                  },
                  {
                    "nom": "bde",
                      "permissions": [
                      {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
211
                        "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
212
213
                      },
                      {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
214
                        "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
215
216
217
218
219
                      }
                    ]
                  }
                ]
    post:
464d0189   Geoffrey PREUD'HOMME   Sécurité
220
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
221
      description: Ajoute un nouveau rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
222
      queryParameters:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
223
224
225
226
227
        nom:
          type: string
          minLength: 3
          required: true
          example: bde
e9bf0f84   badetitou   Evenement
228
      responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
229
230
231
232
233
234
        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é
235
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
236
        description: Supprime un rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
237
        responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
238
239
240
241
242
          204:
            description: Rôle supprimé
          404:
            description: Rôle inconnu
      post:
464d0189   Geoffrey PREUD'HOMME   Sécurité
243
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
244
        description: Ajoute une permission à un rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
245
        queryParameters:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
246
247
248
249
          nom:
            type: string
            required: true
            minLength: 3
e9bf0f84   badetitou   Evenement
250
        responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
251
252
253
254
255
256
          201:
            description: Permission ajouté avec succès
          404:
            description: Permission ou rôle inconnu
      /{nomPermission}:
        delete:
464d0189   Geoffrey PREUD'HOMME   Sécurité
257
          securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
258
          description: Enlève la permission du rôle. Nécessite ROLE_ADMIN
e9bf0f84   badetitou   Evenement
259
          responses:
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
260
261
262
263
264
265
            204:
              description: Permission enlevée avec succès
            404:
              description: Permission ou rôle inconnu
    /permission:
      get:
464d0189   Geoffrey PREUD'HOMME   Sécurité
266
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
267
        description: Liste les permissions. Nécessite ROLE_ADMIN
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
268
269
270
271
272
273
274
        responses:
          200:
            body:
              application/json:
                example: |
                  [
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
275
                      "nom": "CREER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
276
277
                    },
                    {
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
278
                      "nom": "SUPPRIMER_EVNMT"
377081e3   Geoffrey PREUD'HOMME   Rôles et permissions
279
280
                    }
                  ]
e9bf0f84   badetitou   Evenement
281
  
ff2fc742   badetitou   untab
282
283
  /evenement:
    get:
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
284
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
285
      description: Obtenir la liste de tout les evenements. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
ff2fc742   badetitou   untab
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
      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é
306
      securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
307
      description: Permet de creer un nouvel evenement. Nécessite EVNMT_ADMIN
ff2fc742   badetitou   untab
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
      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
323
  
ff2fc742   badetitou   untab
324
325
    /{evenementId}:
      put:
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
326
        description: Permet de modifier un évènement existant. Nécessite EVNMT_ADMIN
bea1faeb   Geoffrey PREUD'HOMME   Plus de sécurité
327
        securedBy: [oauth_2_0]
ff2fc742   badetitou   untab
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
        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é
347
        securedBy: [oauth_2_0]
1ae1d9d5   badetitou   Ajout de transact...
348
        description: Obtenir l'evenement {evenementId}. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
ff2fc742   badetitou   untab
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
        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é
365
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
366
        description: Permet de supprimer l'evenement {evenementId}. Nécessite EVNMT_ADMIN
ff2fc742   badetitou   untab
367
368
369
        responses:
          200:
            description: L'evenement a été bien supprimé
e9bf0f84   badetitou   Evenement
370
371
372
373
  
  
  
  
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
374
  /consommation:
ff2fc742   badetitou   untab
375
    get:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
376
      securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
377
      description: Obtenir la liste de toutes les consommations. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
ff2fc742   badetitou   untab
378
379
380
381
382
383
384
385
      responses:
        200:
          body:
            application/json:
              example: |
                [
                  {
                    "id": 1,
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
386
                    "nomconsommation": "juis de fruit",
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
387
                    "prix": 4
ff2fc742   badetitou   untab
388
389
390
391
                  },
                  {
                    "id": 2,
                    "nomEvenement": "juis de fruit flambe",
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
392
                    "prix": 5
ff2fc742   badetitou   untab
393
394
395
                  }
                ]
    post:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
396
      securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
397
      description: Permet de creer une nouvelle consommation. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
398
      queryParameters:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
399
400
        nomconsommation:
          description: Le nom de la consommation
ff2fc742   badetitou   untab
401
402
403
          type: string
          required: true
        prix:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
404
          description: Le prix de la consommation
ff2fc742   badetitou   untab
405
406
407
408
          type: number
          required: true
      responses:
        201:
e9bf0f84   badetitou   Evenement
409
  
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
410
    /{consommationId}:
ff2fc742   badetitou   untab
411
      put:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
412
        securedBy: [oauth_2_0]
3b818f18   Geoffrey PREUD'HOMME   Ajout des permiss...
413
        description: Permet de modifier une consommation. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
414
415
        queryParameters:
          nomEvenement:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
416
            description: Le nom de la consommation
ff2fc742   badetitou   untab
417
418
419
            type: string
            required: false
          prix:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
420
            description: Le prix de la consommation
ff2fc742   badetitou   untab
421
422
423
424
425
426
427
428
            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é...
429
        securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
430
        description: Obtenir la consommation {consommationId}. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
ff2fc742   badetitou   untab
431
432
433
434
435
436
437
438
439
440
441
442
443
444
        responses:
          200:
            body:
              application/json:
                example: |
                  [
                     {
                      "id": 1,
                      "nomEvenement": "patate",
                      "prix": 4,
                      "date": "2001-09-11"
                    }
                  ]
          404:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
445
            description: consommation non existante
ff2fc742   badetitou   untab
446
      delete:
e8c4d43f   Geoffrey PREUD'HOMME   Encore plus de sé...
447
        securedBy: [oauth_2_0]
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
448
        description: Permet de supprimer la consommation {consommationId}. Nécessite CONSO_ADMIN
ff2fc742   badetitou   untab
449
450
        responses:
          200:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
451
            description: La consommation a été bien supprime
7fa0cd71   badetitou   Les Transactions
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
511
  /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...
512
    /consommation:
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
513
514
515
516
517
518
519
520
521
522
      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...
523
            description: l'indentification de la consommation qui vient d'être payé
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
524
525
        responses:
          201:
0e498f62   Geoffrey PREUD'HOMME   Consomation → Con...
526
            description: La consommation a été bien payé
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
    /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...
542
      /credit:
09db76a6   Geoffrey PREUD'HOMME   Et on génère tout...
543
        post:
1ae1d9d5   badetitou   Ajout de transact...
544
545
546
547
548
549
          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...
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
            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...
565
566
567
568
569
570
571
            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
572
573
574
575
576
577
578
579
580
581
582
583
584
    /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...
585
                      "id": 42,
7fa0cd71   badetitou   Les Transactions
586
587
588
589
590
591
592
                      "type": true,
                      "date": "2003-12-01",
                      "prix": 25.23
                    },
                    {
                      "participant": 1,
                       "acteur": 12,
1ae1d9d5   badetitou   Ajout de transact...
593
                      "id": 43,
7fa0cd71   badetitou   Les Transactions
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
624
                      "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...
625
                  ]