ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

API: samples assiduite/justificatifs

Browse Source
This commit is contained in:
Emmanuel Viennet 2024-07-25 17:04:18 +03:00
parent 71e0a0270c
commit a995e3f886
26 changed files with 2518 additions and 2550 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4467
docs/ScoDoc9API.md
View File

File diff suppressed because it is too large Load Diff

2
docs/img/API_Chart.svg
View File

File diff suppressed because one or more lines are too long
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 440 KiB

After

Width:  |  Height:  |  Size: 436 KiB

6
docs/samples/sample_assiduite.json.md
View File

@ -9,11 +9,11 @@
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"est_just": true,
"etat": "RETARD",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"moduleimpl_id": 3,
"user_id": null,
"user_name": null,
"user_nom_complet": null

10
docs/samples/sample_assiduite_create.json.md
View File

@ -24,15 +24,13 @@
```json
{
"errors": [],
"success": [
"errors": [
{
"indice": 0,
"message": {
"assiduite_id": 49
}
"message": "Duplication: la p\u00e9riode rentre en conflit avec une plage enregistr\u00e9e"
}
]
],
"success": []
}
```

15
docs/samples/sample_assiduite_delete.json.md
View File

@ -8,21 +8,20 @@
```json
{
"errors": [
{
"indice": 0,
"message": "Assiduite non existante"
},
{
"indice": 1,
"message": "Assiduite non existante"
}
],
"success": [
{
"indice": 0,
"message": "OK"
},
{
"indice": 2,
"message": "OK"
"message": "Assiduite non existante"
}
]
],
"success": []
}
```

4
docs/samples/sample_assiduite_justificatifs.json.md
View File

@ -16,12 +16,12 @@
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etat": "VALIDE",
"etudid": 1,
"external_data": null,
"fichier": null,
"justif_id": 1,
"raison": null,
"raison": "MEDIC",
"user_id": null,
"user_name": null,
"user_nom_complet": null

99
docs/samples/sample_assiduites.json.md
View File

@ -2,6 +2,45 @@
#### GET /assiduites/1
```json
[
{
"assiduite_id": 45,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
},
{
"assiduite_id": 46,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
},
"..."
]
```
#### GET /assiduites/1/query?etat=retard
```json
[
{
"assiduite_id": 1,
@ -10,11 +49,11 @@
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"est_just": true,
"etat": "RETARD",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"moduleimpl_id": 3,
"user_id": null,
"user_name": null,
"user_nom_complet": null
@ -23,13 +62,6 @@
]
```
#### GET /assiduites/1/query?etat=retard
```json
[
"..."
]
```
#### GET /assiduites/1/query?moduleimpl_id=1
```json
[
@ -41,37 +73,38 @@
```json
[
{
"assiduite_id": 1,
"assiduite_id": 45,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"justificatifs": [
{
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etudid": 1,
"external_data": null,
"fichier": null,
"justif_id": 1,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
}
],
"moduleimpl_id": 12,
"user_id": null,
"user_name": null,
"user_nom_complet": null
"justificatifs": [],
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
},
{
"assiduite_id": 46,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"justificatifs": [],
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
},
"..."
]

58
docs/samples/sample_assiduites_count.json.md
View File

@ -3,10 +3,10 @@
#### GET /assiduites/1/count
```json
{
"compte": 1,
"demi": 0,
"heure": 0.0,
"journee": 1
"compte": 3,
"demi": 2,
"heure": 4.0,
"journee": 3
}
```
@ -21,10 +21,10 @@
#### GET /assiduites/1/count/query?etat=retard
```json
{
"compte": 0,
"compte": 1,
"demi": 0,
"heure": 0,
"journee": 0
"heure": 0.0,
"journee": 1
}
```
@ -32,10 +32,10 @@
```json
{
"absent": {
"compte": 0,
"demi": 0,
"heure": 0,
"journee": 0,
"compte": 2,
"demi": 2,
"heure": 4.0,
"journee": 2,
"justifie": {
"compte": 0,
"demi": 0,
@ -43,28 +43,28 @@
"journee": 0
},
"non_justifie": {
"compte": 0,
"demi": 0,
"heure": 0,
"journee": 0
"compte": 2,
"demi": 2,
"heure": 4.0,
"journee": 2
}
},
"present": {
"compte": 1,
"demi": 0,
"heure": 0.0,
"journee": 1
},
"retard": {
"compte": 0,
"demi": 0,
"heure": 0,
"journee": 0,
"journee": 0
},
"retard": {
"compte": 1,
"demi": 0,
"heure": 0.0,
"journee": 1,
"justifie": {
"compte": 0,
"compte": 1,
"demi": 0,
"heure": 0,
"journee": 0
"heure": 0.0,
"journee": 1
},
"non_justifie": {
"compte": 0,
@ -74,10 +74,10 @@
}
},
"total": {
"compte": 1,
"demi": 0,
"heure": 0.0,
"journee": 1
"compte": 3,
"demi": 2,
"heure": 4.0,
"journee": 3
}
}
```

36
docs/samples/sample_assiduites_create.json.md
View File

@ -1,5 +1,22 @@
### assiduites_create
#### POST /assiduites/create
> `Content-Type: application/json`
>
> `[{"etudid":1,"date_debut": "2023-10-26T08:00","date_fin": "2023-10-26T10:00","etat": "absent"}]`
```json
{
"errors": [
{
"indice": 0,
"message": "Duplication: la p\u00e9riode rentre en conflit avec une plage enregistr\u00e9e"
}
],
"success": []
}
```
#### POST /assiduites/create
> `Content-Type: application/json`
>
@ -17,22 +34,3 @@
}
```
#### POST /assiduites/create
> `Content-Type: application/json`
>
> `[{"etudid":1,"date_debut": "2023-10-26T08:00","date_fin": "2023-10-26T10:00","etat": "absent"}]`
```json
{
"errors": [],
"success": [
{
"indice": 0,
"message": {
"assiduite_id": 50
}
}
]
}
```

34
docs/samples/sample_assiduites_evaluations.json.md
View File

@ -1,29 +1,17 @@
### assiduites-evaluations
### assiduites_evaluations
#### GET /assiduites/1/evaluations
```json
[
{
"evaluation_id": 1234,
"assiduites": [
{
"assiduite_id": 1,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
]
}
{
"assiduites": [],
"evaluation_id": 1
},
{
"assiduites": [],
"evaluation_id": 2
},
"..."
]
```

40
docs/samples/sample_assiduites_formsemestre.json.md
View File

@ -4,33 +4,33 @@
```json
[
{
"assiduite_id": 1,
"code_nip": "1",
"assiduite_id": 4,
"code_nip": "NIP4",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 1,
"etudid": 4,
"external_data": null,
"moduleimpl_id": 12,
"moduleimpl_id": 13,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
{
"assiduite_id": 2,
"code_nip": "NIP2",
"assiduite_id": 5,
"code_nip": "NIP4",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "RETARD",
"etudid": 2,
"etat": "ABSENT",
"etudid": 4,
"external_data": null,
"moduleimpl_id": 4,
"moduleimpl_id": 7,
"user_id": null,
"user_name": null,
"user_nom_complet": null
@ -43,17 +43,17 @@
```json
[
{
"assiduite_id": 2,
"code_nip": "NIP2",
"assiduite_id": 1,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"est_just": true,
"etat": "RETARD",
"etudid": 2,
"etudid": 1,
"external_data": null,
"moduleimpl_id": 4,
"moduleimpl_id": 3,
"user_id": null,
"user_name": null,
"user_nom_complet": null
@ -82,15 +82,15 @@
```json
[
{
"assiduite_id": 27,
"code_nip": "NIP10",
"assiduite_id": 26,
"code_nip": "11",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 10,
"etudid": 11,
"external_data": null,
"moduleimpl_id": 1,
"user_id": null,
@ -98,15 +98,15 @@
"user_nom_complet": null
},
{
"assiduite_id": 43,
"code_nip": "NIP14",
"assiduite_id": 38,
"code_nip": "NIP16",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "RETARD",
"etudid": 14,
"etudid": 16,
"external_data": null,
"moduleimpl_id": 1,
"user_id": null,

18
docs/samples/sample_assiduites_formsemestre_count.json.md
View File

@ -3,9 +3,9 @@
#### GET /assiduites/formsemestre/1/count
```json
{
"compte": 48,
"demi": 14,
"heure": 65.0,
"compte": 36,
"demi": 13,
"heure": 39.0,
"journee": 18
}
```
@ -13,18 +13,18 @@
#### GET /assiduites/formsemestre/1/count/query?etat=present,retard&metric=compte,heure
```json
{
"compte": 29,
"heure": 35.0
"compte": 25,
"heure": 28.0
}
```
#### GET /assiduites/formsemestre/1/count/query?etat=retard
```json
{
"compte": 14,
"demi": 8,
"heure": 19.0,
"journee": 11
"compte": 15,
"demi": 9,
"heure": 17.0,
"journee": 12
}
```

50
docs/samples/sample_assiduites_group.json.md
View File

@ -11,52 +11,50 @@
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"est_just": true,
"etat": "RETARD",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"moduleimpl_id": 3,
"user_id": null,
"user_name": null,
"user_nom_complet": null
}
],
"2": [
},
{
"assiduite_id": 2,
"code_nip": "NIP2",
"assiduite_id": 46,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "RETARD",
"etudid": 2,
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 4,
"user_id": null,
"user_name": null,
"user_nom_complet": null
}
],
"3": [
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
},
{
"assiduite_id": 3,
"code_nip": "3",
"assiduite_id": 45,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 3,
"etat": "ABSENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 18,
"user_id": null,
"user_name": null,
"user_nom_complet": null
"moduleimpl_id": null,
"user_id": 4,
"user_name": "admin_api",
"user_nom_complet": "Api Admin"
}
]
],
"2": [],
"3": []
}
```

19
docs/samples/sample_justificatif_delete.json.md → docs/samples/sample_justif_delete.json.md
View File

@ -1,28 +1,27 @@
### justificatif_delete
### justif_delete
#### POST /justificatif/delete
> `Content-Type: application/json`
>
> `[2,2,3]`
> `[2, 2, 3]`
```json
{
"errors": [
{
"indice": 0,
"message": "Justificatif non existant"
},
{
"indice": 1,
"message": "Justificatif non existant"
}
],
"success": [
{
"indice": 0,
"message": "OK"
},
{
"indice": 2,
"message": "OK"
"message": "Justificatif non existant"
}
]
],
"success": []
}
```

6
docs/samples/sample_justificatif_edit.json.md → docs/samples/sample_justif_edit.json.md
View File

@ -1,4 +1,4 @@
### justificatif_edit
### justif_edit
#### POST /justificatif/1/edit
> `Content-Type: application/json`
@ -11,7 +11,9 @@
"apres": [
1
],
"avant": []
"avant": [
1
]
}
}
```

9
docs/samples/sample_justificatif_justifies.json.md → docs/samples/sample_justif_justifies.json.md
View File

@ -1,7 +1,10 @@
### justificatif_justifies
### justif_justifies
#### GET /justificatif/1/justifies
```json
[1, 2, "..."]
[
1,
"..."
]
```

10
docs/samples/sample_justif_list.json.md Normal file
View File

@ -0,0 +1,10 @@
### justif_list
#### GET /justificatif/1/list
```json
{
"filenames": [],
"total": 0
}
```

2
docs/samples/sample_justificatif.json.md
View File

@ -7,7 +7,7 @@
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etat": "VALIDE",
"etudid": 1,
"external_data": null,
"fichier": null,

22
docs/samples/sample_justificatif_create.json.md
View File

@ -1,22 +0,0 @@
### justificatif_create
#### POST /justificatif/1/create
> `Content-Type: application/json`
>
> `[{"date_debut": "2023-10-27T08:00","date_fin": "2023-10-27T10:00","etat": "attente"}]`
```json
{
"errors": [],
"success": [
{
"indice": 0,
"message": {
"couverture": [],
"justif_id": 25
}
}
]
}
```

7
docs/samples/sample_justificatif_export.json.md
View File

@ -1,7 +0,0 @@
### justificatif_export
#### POST /justificatif/1/export/nom_fichier
```console
téléchargement du fichier
```

11
docs/samples/sample_justificatif_import.json.md
View File

@ -1,11 +0,0 @@
### justificatif_import
#### POST /justificatif/1/import
> `Content-Type: multipart/form-data`
>
> `binary file`
```json
{ "filename": "nom_du_fichier" }
```

10
docs/samples/sample_justificatif_list.json.md
View File

@ -1,10 +0,0 @@
### justificatif_list
#### GET /justificatif/1/list
```json
{
"total": 1,
"filenames": ["nom_fichier"]
}
```

25
docs/samples/sample_justificatif_remove.json.md
View File

@ -1,25 +0,0 @@
### justificatif_remove
#### POST /justificatif/1/remove
> `Content-Type: application/json`
>
> `{"remove" : "all"}`
```json
{
"response": "remove"
}
```
#### POST /justificatif/1/remove
> `Content-Type: application/json`
>
> `{"remove" : "list", "filenames": ["nom_fichier"]}`
```json
{
"response": "remove"
}
```

84
docs/samples/sample_justificatifs.json.md
View File

@ -8,7 +8,7 @@
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etat": "VALIDE",
"etudid": 1,
"external_data": null,
"fichier": null,
@ -29,85 +29,3 @@
]
```
#### GET /justificatifs/dept/1
```json
[
{
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etudid": 1,
"external_data": null,
"fichier": null,
"formsemestre": {
"id": 1,
"title": "TAPI-BUT-FI-S1-2021"
},
"justif_id": 1,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
{
"code_nip": "NIP2",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "NON_VALIDE",
"etudid": 2,
"external_data": null,
"fichier": null,
"formsemestre": {
"id": 1,
"title": "TAPI-BUT-FI-S1-2021"
},
"justif_id": 2,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
"..."
]
```
#### GET /justificatifs/formsemestre/1
```json
[
{
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etudid": 1,
"external_data": null,
"fichier": null,
"justif_id": 1,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
{
"code_nip": "NIP2",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "NON_VALIDE",
"etudid": 2,
"external_data": null,
"fichier": null,
"justif_id": 2,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
"..."
]
```

14
docs/samples/sample_justificatifs_dept.json.md
View File

@ -4,38 +4,38 @@
```json
[
{
"code_nip": "1",
"code_nip": "3",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etudid": 1,
"etudid": 3,
"external_data": null,
"fichier": null,
"formsemestre": {
"id": 1,
"title": "TAPI-BUT-FI-S1-2021"
},
"justif_id": 1,
"justif_id": 4,
"raison": null,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
{
"code_nip": "NIP2",
"code_nip": "NIP4",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "NON_VALIDE",
"etudid": 2,
"etat": "ATTENTE",
"etudid": 4,
"external_data": null,
"fichier": null,
"formsemestre": {
"id": 1,
"title": "TAPI-BUT-FI-S1-2021"
},
"justif_id": 2,
"justif_id": 5,
"raison": null,
"user_id": null,
"user_name": null,

10
docs/samples/sample_justificatifs_formsemestre.json.md
View File

@ -8,7 +8,7 @@
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "MODIFIE",
"etat": "VALIDE",
"etudid": 1,
"external_data": null,
"fichier": null,
@ -19,15 +19,15 @@
"user_nom_complet": null
},
{
"code_nip": "NIP2",
"code_nip": "3",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"etat": "NON_VALIDE",
"etudid": 2,
"etat": "MODIFIE",
"etudid": 3,
"external_data": null,
"fichier": null,
"justif_id": 2,
"justif_id": 4,
"raison": null,
"user_id": null,
"user_name": null,