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

Assiduites : samples justificatifs

Browse Source
This commit is contained in:
iziram 2023-07-28 14:41:01 +02:00
parent 8ce0af10e8
commit ebe4e92639
6 changed files with 71 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/ScoDoc9API.md
View File

@ -1434,7 +1434,6 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
<!-- TODO: faire les samples -->
#### Structure Assiduité #### Structure Assiduité
| attribut | type | commentaire | | attribut | type | commentaire |
@ -1603,7 +1602,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **assiduites-create** #### **assiduites-create**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoAssiduiteChange`** * **Permission: `ScoAbsChange`**
* **Data:** * **Data:**
```json ```json
@ -1633,7 +1632,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **assiduite-create** #### **assiduite-create**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoAssiduiteChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** * **Paramètres:**
* `etudid` * `etudid`
* `nip` * `nip`
@ -1668,7 +1667,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **assiduite-edit** #### **assiduite-edit**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoAssiduiteChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** `assiduite_id` * **Paramètres:** `assiduite_id`
* **Data:** * **Data:**
@ -1693,7 +1692,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **assiduites-edit** #### **assiduites-edit**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoAssiduiteChange`** * **Permission: `ScoAbsChange`**
* **Data:** * **Data:**
```json ```json
@ -1719,7 +1718,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **assiduite-delete** #### **assiduite-delete**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoAssiduiteChange`** * **Permission: `ScoAbsChange`**
* **Data:** * **Data:**
```json ```json
@ -1793,7 +1792,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-create** #### **justificatif-create**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** * **Paramètres:**
* `etudid` * `etudid`
* `nip` * `nip`
@ -1839,7 +1838,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-edit** #### **justificatif-edit**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** `justif_id` * **Paramètres:** `justif_id`
* **Data:** * **Data:**
@ -1863,7 +1862,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-delete** #### **justificatif-delete**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Data:** * **Data:**
```json ```json
@ -1888,7 +1887,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-import** #### **justificatif-import**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** `justif_id` * **Paramètres:** `justif_id`
> Procédure d'importation de fichier : [importer un justificatif](FichiersJustificatifs.md#importer-un-fichier) > Procédure d'importation de fichier : [importer un justificatif](FichiersJustificatifs.md#importer-un-fichier)
@ -1901,7 +1900,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-export** #### **justificatif-export**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** * **Paramètres:**
* `justif_id` * `justif_id`
* `filename` * `filename`
@ -1916,7 +1915,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
#### **justificatif-remove** #### **justificatif-remove**
* **Méthode:** POST * **Méthode:** POST
* **Permission: `ScoJustifChange`** * **Permission: `ScoAbsChange`**
* **Paramètres:** `justif_id` * **Paramètres:** `justif_id`
> Procédure de suppression de fichier : [supprimer un justificatif](FichiersJustificatifs.md#supprimer-un-fichier) > Procédure de suppression de fichier : [supprimer un justificatif](FichiersJustificatifs.md#supprimer-un-fichier)

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

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

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

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

7
docs/samples/sample_justificatif_justifies.json.md Normal file
View File

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

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

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

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

@ -0,0 +1,25 @@
### 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"
}
```