diff --git a/_data/api/api-declaration-pajemploi.md b/_data/api/api-declaration-pajemploi.md index c8817835f..d947d54f5 100644 --- a/_data/api/api-declaration-pajemploi.md +++ b/_data/api/api-declaration-pajemploi.md @@ -19,7 +19,7 @@ access_page: - Attestation fiscale - Attestation sociale - + - who: - Un editeur de logiciel de paie - Autres activités diff --git a/_data/api/api-statut-etudiant-ecriture.md b/_data/api/api-statut-etudiant-ecriture.md index fa71f5d7d..b199078d0 100644 --- a/_data/api/api-statut-etudiant-ecriture.md +++ b/_data/api/api-statut-etudiant-ecriture.md @@ -48,7 +48,7 @@ themes: - Particulier - Education contact_link: support-statutetudiant@renater.fr -doc_tech_link: /swaggers/api-statut-etudiant-ecriture.json +doc_tech_link: /swaggers/StatutEtudiant-POST-inscription-v4-complet.json visits_2019: 4000 last_update: 25/01/2022 --- @@ -70,10 +70,14 @@ Seuls les étudiants dont les établissements transmettent leurs données pourro | Donnée | Description | | ------------------------------------------------------- | ------------------------------------------------------------------------ | -| INE | Identifiant National étudiant | -| Date de naissance | Date de naissance de l'étudiant | -| Code commune | Code postal de la commune de l'établissement | -| Régime | Formation initiale / formation continue | -| Statut | Exemple : admis | -| Date de début | Date de début de l’inscription. Exemple : 2021-09-01 | -| Date de fin | Date de fin de l’inscription. Exemple : 2022-08-31 | +| ine | Identifiant National étudiant | +| dateNaissance | Date de naissance de l'étudiant | +| codeCommne | Code postal de la commune de l'établissement | +| regime | Formation initiale / formation continue | +| statut | Exemple : admis | +| dateDebutInscription | Date de début de l’inscription. Exemple : 2021-09-01 | +| dateFinInscription | Date de fin de l’inscription. Exemple : 2022-08-31 +| uai | Identifiant de l'établissement | +| cursus | L = Licence, M = Master, D = Doctorat (Par défaut : non renseigné) | +| diplome | Code diplôme SISE ou code MEFSTAT11 (pour lycées) +| niveauDiplome | Niveau d'année dans le diplôme | diff --git a/_data/api/webstat.md b/_data/api/webstat.md index 2d239e811..2c45af5d1 100644 --- a/_data/api/webstat.md +++ b/_data/api/webstat.md @@ -3,7 +3,7 @@ title: Webstat # nom commercial de l'API tagline: Accédez aux séries économiques de la Banque de France # une phrase maximum producer: banque-de-france is_open: 0 # -1 means API not open -account_link: https://webstat.banque-france.fr/signup/ # URL d'une page de demande d'habilitation si l'API est à accès restreint +account_link: https://webstat.banque-france.fr/fr/pages/guide-migration-api/ # URL d'une page de demande d'habilitation si l'API est à accès restreint partners: # liste de co-producteurs de l'API - BCE (ECB) - FMI (IMF) @@ -27,10 +27,10 @@ visits_2019: 8 last_update: 20/12/2019 --- -[Webstat](http://webstat.banque-france.fr/fr/) est le portail statistique de la Banque de France. L'[API Webstat](https://developer.webstat.banque-france.fr) permet d'accéder à plus de 35.000 séries statistiques de la Banque de France et de ses partenaires institutionnels. Obtenez simplement les données économiques et financières sur les entreprises françaises, la conjoncture régionale, le crédit et l'épargne, la monnaie ou la balance des paiements. +[Webstat](http://webstat.banque-france.fr/fr/) est le portail statistique de la Banque de France. L'[API Webstat](https://webstat.banque-france.fr/fr/pages/guide-migration-api/) permet d'accéder à plus de 40.000 séries statistiques de la Banque de France et de ses partenaires institutionnels. Obtenez simplement les données économiques et financières sur les entreprises françaises, la conjoncture régionale, le crédit et l'épargne, la monnaie ou la balance des paiements. Principales fonctionnalités: - catalogue des jeux de données et des séries - téléchargement des données et métadonnées disponibles sur le portail - nombreuses possibilités de filtrage -- formats JSON, XML ou CSV +- formats JSON, XLSX ou CSV diff --git a/public/swaggers/StatutEtudiant-POST-inscription-v4-complet.json b/public/swaggers/StatutEtudiant-POST-inscription-v4-complet.json new file mode 100644 index 000000000..4f30953ed --- /dev/null +++ b/public/swaggers/StatutEtudiant-POST-inscription-v4-complet.json @@ -0,0 +1,387 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "API SupData", + "description": "\r\n## Bienvenue sur la documentation interactive d'API Supdata.\r\nAPI de l'insertion des inscriptions dans la base SupData\r\n\r\n#### Tokens valides :\r\n-----------\r\n\r\n 2ed3c3176ad1a803603841b13fd3437a\r\n\r\n#### étudiants valides\r\n-----------\r\n 0AYIOP071Y8 1996-12-26\r\n 081768862AE 1999-11-30\r\n\r\n### établissements valides\r\n-----------\r\n 0010006B LPO LYCEE DES METIERS SAINT-EXUPERY (01206)\r\n 0010814E LYCEE PROFESSIONNEL PRIVE SAINT JOSEPH (01700)\r\n 0011402U EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE (01000)\r\n\r\n\r\n", + "contact": { + "email": "support@renater.fr" + }, + "version": "1.0.0" + }, + "servers": [ + { + "url": "{schema}://{baseUrl}/api/", + "description": "Api SupData", + "variables": { + "schema": { + "enum": [ + "https", + "http" + ], + "default": "http" + }, + "baseUrl": { + "enum": [ + "192.168.1.22/supdata/middle/set", + "ix1-dv-u18-supdataapi-01.renater.fr", + "ix1-dv-u18-supdataapi-02.renater.fr", + "ix1-qv-u18-supdatamiddle-01.renater.fr" + ], + "default": "ix1-qv-u18-supdatamiddle-01.renater.fr" + } + } + } + ], + "paths": { + "/inscription": { + "post": { + "tags": [ + "inscription" + ], + "summary": "Insertion unitaire d'une inscription", + "description": "Le service permet d'insérer les inscriptions de façon unitaire", + "operationId": "InscriptionEndpoint::post", + "parameters": [ + { + "name": "X-API-Key", + "in": "header", + "description": "Le token d'identification pour l'API", + "required": true, + "schema": { + "type": "string" + }, + "example": "3841b13fa8032ed3c31d160d3437a76a" + } + ], + "requestBody": { + "description": "Client side search object", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BodySchema" + } + } + } + }, + "responses": { + "200": { + "description": "L'étudiant correspondant aux critères de recherche", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SucessSchema" + } + } + } + }, + "400": { + "description": "la valeur du paramètre n'est pas valide", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorSchema400" + } + } + } + }, + "401": { + "description": "Le token ne vous permet pas d'accéder a l'API", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorSchema401" + } + } + } + }, + "404": { + "description": "etudiant ou établissement introuvable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorSchema404" + } + } + } + }, + "500": { + "description": "Erreur Serveur Interne", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorSchema500" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "BodySchema": { + "properties": { + "ine": { + "title": "INE", + "description": "INE", + "type": "string", + "format": "string", + "example": "070578267KH" + }, + "dateNaissance": { + "title": "Date de naissance", + "description": "date de naissance", + "type": "string", + "format": "date", + "example": "1999-03-30" + }, + "dateDebutInscription": { + "title": "date debut inscription", + "description": "date debut inscription", + "type": "string", + "format": "date", + "example": "2019-09-01" + }, + "dateFinInscription": { + "title": "date fin inscription", + "description": "date fin inscription", + "type": "string", + "format": "date", + "example": "2020-08-31" + }, + "statut": { + "type": "string", + "example": "1" + }, + "regime": { + "type": "string", + "example": "1" + }, + "codeCommune": { + "type": "string", + "format": "string", + "example": "44000" + }, + "uai": { + "title": "UAI", + "description": "UAI", + "type": "string", + "format": "sring", + "example": "0011402U" + }, + "cursus": { + "title": "cursus", + "description": "cursus", + "type": "string", + "format": "string", + "example": "L" + }, + "diplome": { + "title": "diplome", + "description": "diplome", + "type": "string", + "format": "string", + "example": "diplom1" + }, + "niveauDiplome": { + "title": "niveauDiplome", + "description": "niveauDiplome", + "type": "string", + "format": "string", + "example": "01" + } + }, + "type": "object" + }, + "ErrorSchema400": { + "required": [ + "message", + "uid", + "details" + ], + "properties": { + "message": { + "type": "string", + "example": "la valeur du paramètre n'est pas valide" + }, + "uid": { + "type": "string", + "example": "5e68e563116ab_0000" + }, + "details": { + "type": "object", + "example": { + "method": "POST", + "endpoint": "inscription", + "parameter": "le format ode l' INE n'est pas valide" + } + } + }, + "type": "object" + }, + "ErrorSchema401": { + "required": [ + "message", + "uid", + "details" + ], + "properties": { + "message": { + "type": "string", + "example": "échec d'authentification" + }, + "uid": { + "type": "string", + "example": "5e68e563116ab_0000" + }, + "details": { + "type": "object", + "example": { + "method": "POST", + "endpoint": "inscription", + "parameter": "le token 384 n'est pas valide" + } + } + }, + "type": "object" + }, + "ErrorSchema404": { + "required": [ + "message", + "uid", + "details" + ], + "properties": { + "message": { + "type": "string", + "example": "étudiant introuvable" + }, + "uid": { + "type": "string", + "example": "5e68e563116ab_0000" + }, + "details": { + "type": "object", + "example": { + "method": "POST", + "endpoint": "inscription", + "parameter": [ + "080890290EH", + "2000-05-30" + ] + } + } + }, + "type": "object" + }, + "ErrorSchema500": { + "required": [ + "message", + "uid", + "details" + ], + "properties": { + "message": { + "type": "string", + "example": "erreur serveur interne" + }, + "uid": { + "type": "string", + "example": "5e68e563116ab_0000" + }, + "details": { + "type": "object", + "example": { + "method": "POST", + "endpoint": "inscription", + "parameter": "" + } + } + }, + "type": "object" + }, + "InscriptionSchema": { + "properties": { + "id_inscription": { + "title": "ID de l'inscription", + "description": "id de l'inscription", + "type": "string", + "format": "int", + "example": "12" + }, + "ine": { + "title": "INE", + "description": "INE", + "type": "string", + "format": "int", + "example": "090567778FF" + }, + "dateNaissance": { + "title": "Date de naissance", + "description": "date de naissance", + "type": "object", + "format": "date", + "example": "1999-09-01" + }, + "dateDebutInscription": { + "title": "date debut inscription", + "description": "date debut inscription", + "type": "string", + "format": "date", + "example": "2019-09-01" + }, + "dateFinInscription": { + "title": "date fin inscription", + "description": "date fin inscription", + "type": "string", + "format": "date", + "example": "2020-08-31" + }, + "statut": { + "type": "string", + "enum": [ + "admis", + "inscrit" + ] + }, + "codeCommune": { + "type": "string", + "format": "string", + "example": "44000" + }, + "uai": { + "title": "UAI", + "description": "UAI", + "type": "string", + "format": "string", + "example": "0011402U" + } + }, + "type": "object" + }, + "SucessSchema": { + "properties": { + "message": { + "title": "Message retour", + "description": "Message retour", + "type": "string", + "format": "string", + "example": "une nouvelle inscription créée" + }, + "inscription": { + "$ref": "#/components/schemas/InscriptionSchema" + } + }, + "type": "object" + } + } + }, + "tags": [ + { + "name": "inscription", + "description": "Insertion des inscriptions" + } + ] +} \ No newline at end of file