Skip to content

Commit 2de5950

Browse files
hugofnmhugofnm
committed
docs: update api ade docs
1 parent 3c98e9f commit 2de5950

4 files changed

Lines changed: 183 additions & 8 deletions

File tree

‎.docs/ADE_API.md‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# Documentation officielle de l'API ADE
2+
3+
À l'aide de l'API d'ADE, il est possible de récupérer les créneaux pour une journée, mais aussi pour une promotion voulue.
4+
5+
## CONNECT
6+
Se connecter à une session et ainsi récupérer un sessionId.
7+
8+
`https://adresse-ade/jsp/webapi?function=connect&login=xxxxxxxxxxxxx&password=xxxxxxxxxxxxx`
9+
10+
```
11+
Params :
12+
13+
function → connect
14+
login → l’identifiant de l’utilisateur
15+
password → le mot de passe de l’utilisateur
16+
```
17+
18+
## DISCONNECT
19+
Se déconnecter à une session.
20+
21+
`https://adresse-ade/jsp/webapi?sessionId=xxxxxxxxxxxxx&function=disconnect`
22+
23+
```
24+
Params :
25+
26+
function → disconnect
27+
sessionId → l’ID de la session
28+
```
29+
30+
## GETPROJECTS
31+
Récupérer les projets
32+
33+
`https://adresse-ade/jsp/webapi?sessionId=xxxxxxxxxxxxx&function=getProjects`
34+
35+
```
36+
Params :
37+
38+
function → getProjects
39+
sessionId → l’ID de la session
40+
```
41+
42+
## SETPROJECT
43+
Accèder à un projet
44+
45+
`https://adresse-ade/jsp/webapi?sessionId=xxxxxxxxxxxxx&function=setProject&projectId=5`
46+
47+
```
48+
Params :
49+
50+
function → setProject
51+
sessionId → l’ID de la session
52+
projectId → l’ID du projet
53+
```
54+
55+
## GETRESOURCES
56+
Récupérer les ressources
57+
58+
`https://adresse-ade/jsp/webapi?sessionId=xxxxxxxxxxxxx&function=getResources&name=EP3&detail=3`
59+
60+
```
61+
Params :
62+
63+
function → getResources
64+
sessionId → l’ID de la session
65+
name (optionnel) → nom de la ressource
66+
id (optionnel) → l’ID de la ressource
67+
detail (optionnel) → le niveau de détail (voir ci-dessous)
68+
Autres paramètres optionnels : tree, folders, leaves, category, type, email, url, size, quantity, code, address1, address2, zipCode, state, city, country, telephone, fax, timezone, jobCategory, manager, codeX, codeY, codeZ, info
69+
```
70+
71+
Exemple d’une ressource :
72+
73+
```xml
74+
<resources>
75+
<resource id="1179" name="EP3" path="EP." category="category5"/>
76+
</resources>
77+
```
78+
79+
## GETEVENTS
80+
Récupérer les évennements de la journée
81+
82+
`https://adresse-ade/jsp/webapi?sessionId=xxxxxxxxxxxxx&function=getEvents&date=05/02/2023&detail=0``
83+
84+
```
85+
Params :
86+
87+
function → getEvents
88+
sessionId → l’ID de la session
89+
eventId (optionnel) → l’ID de l’évent
90+
date (optionnel) → la date au format mm/dd/yyyy
91+
detail (optionnel) → le niveau de détail (voir ci-dessous)
92+
resources (optionnel) → l’ID des ressources espacé par « | »
93+
````
94+
95+
Dans un event, on peut retrouver ⇒
96+
97+
le nom du cours
98+
Horaire de début/fin
99+
100+
Les ressources :
101+
nom de la ressource ( STPI12-TP-G2 / NOM Prénom / Amphi S – ESITECH / STPI1 ...)
102+
103+
categorie :
104+
trainee = étudiants
105+
instructor = enseignants
106+
classroom = la salle
107+
category5 = groupe
108+
109+
Exemple d’un event :
110+
111+
```xml
112+
<events>
113+
<event id="24412" activityId="10003" session="0" repetition="0" name="STPI12-C2-CM-2-1" endHour="09:30" startHour="08:00" date="02/05/2023" absoluteSlot="14722" slot="4" day="1" week="37" additionalResources="0" duration="6" info="AMPHI S" note="1679982923895" color="255,255,255" isLockPosition="false" oldDuration="6" oldSlot="4" oldDay="1" oldWeek="39" lastUpdate="02/10/2023 09:37" creation="02/03/2023 17:31" isLockResources="false" isSoftKeepResources="false" isNoteLock="false" isStrongLock="false">
114+
<resources>
115+
<resource fromWorkflow="false" nodeId="50514" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-E1" id="2286"/>
116+
<resource fromWorkflow="false" nodeId="50515" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-E2" id="2287"/>
117+
<resource fromWorkflow="false" nodeId="50516" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-F1" id="2288"/>
118+
<resource fromWorkflow="false" nodeId="50517" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-F2" id="2289"/>
119+
<resource fromWorkflow="false" nodeId="50518" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-G1" id="2290"/>
120+
<resource fromWorkflow="false" nodeId="50519" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-G2" id="2291"/>
121+
<resource fromWorkflow="false" nodeId="50520" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-H1" id="2292"/>
122+
<resource fromWorkflow="false" nodeId="50521" nodeOrId="-1" quantity="1" category="trainee" name="STPI12-TP-H2" id="2293"/>
123+
<resource fromWorkflow="false" nodeId="50522" nodeOrId="-1" quantity="1" category="instructor" name="NOM Prénom" id="641"/>
124+
<resource fromWorkflow="false" nodeId="49899" nodeOrId="-1" quantity="1" category="classroom" name="Amphi S - ESITECH" id="1596"/>
125+
<resource fromWorkflow="false" nodeId="50523" nodeOrId="-1" quantity="1" category="category5" name="STPI1" id="1171"/>
126+
</resources>
127+
<additional/>
128+
</event>
129+
</events>
130+
```
131+
132+
Le paramètre détail permet de spécifier le niveau de détail de la trame xml retournée :
133+
134+
```
135+
1: id
136+
2: & name
137+
3: & type & folderId
138+
4: & url
139+
5: & size
140+
6: & repetition
141+
7: & duration & nbEventsPlaced & durationInMinutes & firstWeek & firstDay & firstSlot & lastWeek & lastDay & lastSlot & creation & lastUpdate
142+
8: & email
143+
9: & color & code & timezone & codeX & codeY & codeZ & info & maxSeats & seatsLeft & weight
144+
10: & isActive
145+
11: & isNotSameDay
146+
12: & isGrouped
147+
13: & isAligned & isSuccessiveDay
148+
14: & rights & owner
149+
15: & resources
150+
16 or 0: & resource costs
151+
17: & events of the activity
152+
```

‎.docs/DATA.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
This data is stored in the secure enclave (Keychain from Apple / Keystore from Android) of the device, which is a secure storage system that is used to store sensitive data. The data is encrypted and can only be accessed by the user with biometrical authentication or a password (phone PIN).
99

1010
- ```username```: Username of the user
11-
- ```password```: Password of the user
12-
- ```name```: Full name of the user
1311

1412
## Data stored in AsyncStorage
1513

@@ -18,10 +16,5 @@ This data is stored in the secure enclave (Keychain from Apple / Keystore from A
1816

1917
This data is stored in the AsyncStorage of the device, which is a storage system that is used to store data. The data is not encrypted and can be accessed by the user.
2018

21-
- ```autoSet```: Boolean value to check if the user has chosen to automatically calculate the overall average
2219
- ```haptics```: Boolean value to check if the user has chosen to enable haptics
23-
- ```configAverage```: String value that contains or the letter B for bonus or the letter M for malus
24-
- ```matiereBonus```: String value that contains the name of the subject that will be used for the bonus
25-
- ```matiereMalus```: String value that contains the name of the subject that will be used for the malus
26-
- ```calendar```: Array of objects containing the calendar events
27-
- ```server```: String value that contains the name of the server that the user has chosen
20+
- ```calendar```: Array of objects containing the calendar events

‎package-lock.json‎

Lines changed: 29 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"expo-local-authentication": "~55.0.14",
3939
"expo-network": "~55.0.14",
4040
"expo-notifications": "~55.0.23",
41+
"expo-observe": "~0.2.2",
4142
"expo-router": "~55.0.16",
4243
"expo-secure-store": "~55.0.14",
4344
"expo-sharing": "~55.0.18",

0 commit comments

Comments
 (0)