api.raml
3.64 KB
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
#%RAML 0.8
title: API d'Etunicorn
baseUri: https://etunicorn.plil.net/{version}/
version: v1
# Les codes 401 et 400 sont implicites
/login:
post:
description: Instancie une nouvelle connexion
queryParameters:
login:
displayName: Login Polytech
type: string
required: true
password:
displayName: Mot de passe Polytech
type: string
required: false
responses:
200:
description: Authentification réussie
body:
application/json:
example: |
{
"token": "ooT6zahdura7vaethuiph1ugiph6co",
"expire": 1485607703
}
401:
description: Authentication échouée
/{token}:
delete:
description: Se déconnecter
responses:
204:
description: Déconnecté avec succès
404:
description: Jeton non trouvé
/personne:
get:
description: Obtenir la liste des persones
responses:
200:
body:
application/json:
example: |
[
{
"id": 42,
"carte": "AAAAA",
"naissance": "1997-02-14",
"solde": 1337,
"login": "gbontoux"
}
]
/{idPersonne}:
get:
description: Obtenir les infos sur une personne
responses:
200:
description: Utilisateur récupéré
body:
application/json:
example: |
{
"id": 42,
"carte": "AAAAA",
"naissance": "1997-02-14",
"solde": 1337,
"login": "gbontoux"
}
404:
description: Utilisateur non trouvé
put:
description: Modifer les infos d'une personne
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
required: false
example: 1997-02-14
login:
displayName: Login Polytech
type: string
required: false
example: gbontoux
responses:
202:
description: Utilisateur modifié
body:
application/json:
example: |
{
"id": 42,
"carte": "AAAAA",
"naissance": "1997-02-14",
"solde": 1337,
"login": "gbontoux"
}
404:
description: Utilisateur non trouvé
delete:
description: Obtenir les infos sur une personne
responses:
204:
description: Utilisateur supprimé
404:
description: Utilisateur non trouvé
post:
description: Ajoute une nouvelle personne
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
required: false
example: 1997-02-14
login:
displayName: Login Polytech
type: string
required: false
example: gbontoux
responses:
201:
description: Personne ajoutée avec succès
body:
application/json:
example: |
{
"id": 42
}