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

Assiduité : Docs : erratum + oublie samples

Browse Source
This commit is contained in:
Iziram 2024-03-29 16:37:43 +01:00
parent 7ef0f108b4
commit 58e3ee9500
4 changed files with 102 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/ScoDoc9API.md
View File

@ -1898,6 +1898,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
etudid3 : [{assiduité...}], etudid3 : [{assiduité...}],
} }
``` ```
* **Exemple de résultat:** [assiduites-group.json](samples/sample_assiduites_group.json.md)
#### **assiduites-create** #### **assiduites-create**
@ -1924,6 +1925,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
> `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "absent","etudid":1}]` > `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "absent","etudid":1}]`
* **Résultat:** Retourne un objet en deux parties (errors et success) contenant le retour de chaque objet donné dans la requête POST. * **Résultat:** Retourne un objet en deux parties (errors et success) contenant le retour de chaque objet donné dans la requête POST.
* **Exemple de résultat:** [assiduites-create.json](samples/sample_assiduites_create.json.md)
#### **assiduite-create** #### **assiduite-create**
@ -2032,18 +2034,19 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### Structure Justificatif #### Structure Justificatif
| attribut | type | commentaire | | attribut | type | commentaire |
| :----------- | :------------- | :------------------------------------------------------------ | | :-------------- | :------------- | :------------------------------------------------------------ |
| *justif_id* | int | identifiant unique | | *justif_id* | int | identifiant unique |
| *etudid* | int | identifiant unique de l'étudiant concerné par le justificatif | | *etudid* | int | identifiant unique de l'étudiant concerné par le justificatif |
| *date_debut* | string | date ISO du début de la période du justificatif | | *date_debut* | string | date ISO du début de la période du justificatif |
| *date_fin* | string | date ISO de la fin de la période du justificatif | | *date_fin* | string | date ISO de la fin de la période du justificatif |
| *etat* | string | état du justificatif ( attente, valide, non_valide, modifie) | | *etat* | string | état du justificatif ( attente, valide, non_valide, modifie) |
| *raison* | string ou null | explication du justificatif si présente | | *raison* | string ou null | explication du justificatif si présente |
| *fichier* | string | identifiant de l'archivage des fichiers | | *fichier* | string | identifiant de l'archivage des fichiers |
| *user_id* | int or null | id de l'utilisateur ayant créé le justificatif | | *user_id* | int or null | id de l'utilisateur ayant créé le justificatif |
| *user_name* | str ou null | login de l'utilisateur ayant créé le justificatif | | *user_name* | str ou null | login de l'utilisateur ayant créé le justificatif |
| *entry_date* | string | date ISO de l'entrée du justificatif | | *entry_date* | string | date ISO de l'entrée du justificatif |
| *external_data* | objet ou null | un objet décrivant des actions non utilisée par ScoDoc |
#### **justificatif** #### **justificatif**

2
docs/samples/sample_assiduites_justificatifs.json.md → docs/samples/sample_assiduite_justificatifs.json.md
View File

@ -1,4 +1,4 @@
### assiduites_justificatifs ### assiduite_justificatifs
#### GET /assiduite/1/justificatifs #### GET /assiduite/1/justificatifs
```json ```json

47
docs/samples/sample_justificatifs_dept.json.md Normal file
View File

@ -0,0 +1,47 @@
### justificatifs_dept
#### 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
},
"..."
]
```

39
docs/samples/sample_justificatifs_formsemestre.json.md Normal file
View File

@ -0,0 +1,39 @@
### justificatifs_formsemestre
#### 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
},
"..."
]
```