forked from ScoDoc/DocScoDoc
Mise à jour de la doc API
Ajout des annotations
This commit is contained in:
parent
4aff3a212f
commit
7995348749
@ -438,31 +438,32 @@ 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! |
|
||||
| _code_nip_ | string | non unique! |
|
||||
| _dept_id_ | string | id du département scodoc |
|
||||
| _id_ | int | id unique |
|
||||
| _nom_ | string | en majuscule [[1]](DonneesEtudiant.md) |
|
||||
| _nom_usuel_ | string | null si absent [[1]](DonneesEtudiant.md) |
|
||||
| _prenom_ | string | [[1]](DonneesEtudiant.md) |
|
||||
| _prenom_etat_civil_ | string | (si prenom d'usage <> etat_civil [[1]](DonneesEtudiant.md)) |
|
||||
| _sort_key_ | [ string, string ] | nom-prenom pour trier |
|
||||
| | | **Format long** |
|
||||
| _admission_ | admission | |
|
||||
| _adresses_ | [adresse](#structure-adresse) | |
|
||||
| _boursier_ | bool | |
|
||||
| _date_naissance_ | string | date ISO (yyyy-mm-dd) |
|
||||
| _dept_acronym_ | string | |
|
||||
| _dept_naissance_ | string | département du lieu de naissance |
|
||||
| _lieu_naissance_ | string | lieu de naissance (ville) |
|
||||
| _nationalite_ | string | |
|
||||
| _photo_filename_ | string | |
|
||||
| _scodoc7_id_ | string | de la forme 'EID9999' |
|
||||
| _statut_ | string | '`I`', '`D`' ou '`X`' |
|
||||
| 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! |
|
||||
| _code_nip_ | string | non unique! |
|
||||
| _dept_id_ | string | id du département scodoc |
|
||||
| _id_ | int | id unique |
|
||||
| _nom_ | string | en majuscule [[1]](DonneesEtudiant.md) |
|
||||
| _nom_usuel_ | string | null si absent [[1]](DonneesEtudiant.md) |
|
||||
| _prenom_ | string | [[1]](DonneesEtudiant.md) |
|
||||
| _prenom_etat_civil_ | string | (si prenom d'usage <> etat_civil [[1]](DonneesEtudiant.md)) |
|
||||
| _sort_key_ | [ string, string ] | nom-prenom pour trier |
|
||||
| | | **Format long** |
|
||||
| _admission_ | admission | |
|
||||
| _adresses_ | [adresse](#structure-adresse) | |
|
||||
| _boursier_ | bool | |
|
||||
| _date_naissance_ | string | date ISO (yyyy-mm-dd) |
|
||||
| _dept_acronym_ | string | |
|
||||
| _dept_naissance_ | string | département du lieu de naissance |
|
||||
| _lieu_naissance_ | string | lieu de naissance (ville) |
|
||||
| _nationalite_ | string | |
|
||||
| _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`**
|
||||
|
@ -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",
|
||||
|
@ -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",
|
||||
|
@ -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",
|
||||
|
Loading…
Reference in New Issue
Block a user