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

Mise à jour de la doc API #61

Merged
viennet merged 1 commits from :api-annot into master 2024-02-11 12:37:28 +01:00
Conversation 0 Commits 1 Files Changed 4 +107 -25
4 changed files with 107 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 7995348749 - Show all commits

13
docs/ScoDoc9API.md
View File

@ -439,7 +439,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
#### Structure Etudiant
| attribut | type | commentaire |
|:----------------------|:------------------------------|:------------------------------------------------------------|
|:----------------------|:------------------------------------|:------------------------------------------------------------|
| _civilite_ | string | '`M`', '`F`' ou '`X`' [[1]](DonneesEtudiant.md) |
| _civilite_etat_civil_ | string | '`M`', '`F`' ou '`X`' [[1]](DonneesEtudiant.md) |
| _code_ine_ | string | non unique! |
@ -463,6 +463,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
| _photo_filename_ | string | |
| _scodoc7_id_ | string | de la forme 'EID9999' |
| _statut_ | string | '`I`', '`D`' ou '`X`' |
| _annotations_ | [annotation](#structure-annotation) | |
##### Structure adresse
@ -483,6 +484,16 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
| typeadresse | string | |
| villedomicile | string | |
##### Structure annotation
| attribut | type | commentaire |
|:---------|:-------|:------------|
| date | string | |
| id | int | |
| comment | string | |
| author | string | |
| etudid | int | |
#### **`etudiants-courants`**

27
docs/samples/sample_etudiant.json.md
View File

@ -47,6 +47,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",
@ -120,6 +129,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",
@ -193,6 +211,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",

27
docs/samples/sample_etudiants-clef.json.md
View File

@ -48,6 +48,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",
@ -124,6 +133,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",
@ -200,6 +218,15 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T18:40:04.114300+01:00",
"id": 5,
"comment": "Ceci est une annotation.",
"author": "admin",
"etudid": 11
}
],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",

17
docs/samples/sample_etudiants-courants.json.md
View File

@ -87,6 +87,22 @@
"villedomicile": null
}
],
"annotations": [
{
"date": "2024-02-10T12:16:04.336100+01:00",
"id": 2,
"comment": "Une deuxième annotation.",
"author": "admin",
"etudid": 1
},
{
"date": "2024-02-10T12:14:34.243300+01:00",
"id": 1,
"comment": "Une annotation.",
"author": "admin",
"etudid": 1
}
],
"boursier": null,
"civilite": "X",
"civilite_etat_civil": "X",
@ -156,6 +172,7 @@
"villedomicile": null
}
],
"annotation": [],
"boursier": null,
"civilite": "F",
"civilite_etat_civil": "X",