diff --git a/src/main/resources/openapi.json b/src/main/resources/openapi.json new file mode 100644 index 00000000..ce727946 --- /dev/null +++ b/src/main/resources/openapi.json @@ -0,0 +1,8831 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "API RMéS", + "description": "API sur les métadonnées de l'Insee", + "version": "3.7.2" + }, + "servers": [ + { + "url": "http://localhost:8080/metadata-api" + } + ], + "tags": [ + { + "name": "nomenclatures", + "description": "Nomenclatures API" + }, + { + "name": "concepts", + "description": "Concepts API" + }, + { + "name": "geographie", + "description": "Geographie API" + }, + { + "name": "operations", + "description": "Operations API" + } + ], + "paths": { + "/technicalService/describe": { + "get": { + "summary": "Service pour déréférencer une uri", + "operationId": "describeUri", + "parameters": [ + { + "name": "uri", + "in": "query", + "description": "Iri à déréférencer", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + } + } + } + }, + "/healthcheck": { + "get": { + "operationId": "getHealthcheck", + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + } + } + } + }, + "/codes/cj/n2/{code}": { + "get": { + "tags": [ + "nomenclatures" + ], + "summary": "Informations sur une catégorie juridique de niveau 2", + "operationId": "getcjn2", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Identifiant de la catégorie juridique de niveau 2 (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string" + }, + "example": 10 + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Catégorie juridique de niveau 2", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategorieJuridiqueNiveauII" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CategorieJuridiqueNiveauII" + } + } + } + } + } + } + }, + "/codes/cj/n3/{code}": { + "get": { + "tags": [ + "nomenclatures" + ], + "summary": "Informations sur une catégorie juridique de niveau 3", + "operationId": "getcjn3", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Identifiant de la catégorie juridique de niveau 3 (quatre chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{4}", + "type": "string" + }, + "example": 7112 + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Catégorie juridique de niveau 3", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategorieJuridiqueNiveauIII" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CategorieJuridiqueNiveauIII" + } + } + } + } + } + } + }, + "/codes/nafr2/classe/{code}": { + "get": { + "tags": [ + "nomenclatures" + ], + "summary": "Informations sur une classe de la NAF rév.2 identifiée par son code", + "operationId": "getnafr2n4", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la classe (deux chiffres, un point, deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}\\.[0-9]{2}", + "type": "string" + }, + "example": 46.66 + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Classe de la NAF", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClasseNAF2008" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ClasseNAF2008" + } + } + } + } + } + } + }, + "/codes/nafr2/sousClasse/{code}": { + "get": { + "tags": [ + "nomenclatures" + ], + "summary": "Informations sur une sous-classe de la NAF rév.2 identifiée par son code", + "operationId": "getnafr2n5", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la sous-classe (deux chiffres, un point, deux chiffres et une lettre majuscule)", + "required": true, + "schema": { + "pattern": "[0-9]{2}\\.[0-9]{2}[A-Z]", + "type": "string" + }, + "example": "33.16Z" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Sous-classe de la NAF", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SousClasseNAF2008" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/SousClasseNAF2008" + } + } + } + } + } + } + }, + "/concepts/definition/{id}": { + "get": { + "tags": [ + "concepts" + ], + "summary": "Informations sur la définition d'un concept statistique de l'Insee", + "operationId": "getconcept", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifiant du concept (format : c[0-9]{4})", + "required": true, + "schema": { + "pattern": "c[0-9]{4}", + "type": "string" + }, + "example": "c2066" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Concept", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Definition" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Definition" + } + } + } + } + } + } + }, + "/concepts/definitions": { + "get": { + "tags": [ + "concepts" + ], + "summary": "Informations sur les définitions des concepts statistiques de l'Insee", + "operationId": "getConcepts", + "parameters": [ + { + "name": "libelle", + "in": "query", + "description": "Recherche dans les libellés", + "schema": { + "type": "string" + }, + "example": "élect" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Concepts", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Definitions" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntituleDefinition" + } + } + } + } + } + } + }, + "/geo/pays/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un pays identifié par son code (cinq chiffres)", + "operationId": "getcogpays", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du pays (cinq chiffres, débutant par 99)", + "required": true, + "schema": { + "pattern": "99[0-9]{3}", + "type": "string", + "example": "99217" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Pays", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "/geo/aireDAttractionDesVilles2020/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une aire d'attraction française identifiée par son code (trois caractères)", + "operationId": "getcogaav", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'aire d'attraction (trois chiffres)", + "required": true, + "schema": { + "pattern": "[a-zA-Z0-9]{3}", + "type": "string", + "example": "062" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer l'aire d'attraction active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Aire d'attraction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AireDAttractionDesVilles2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AireDAttractionDesVilles2020" + } + } + } + } + } + } + }, + "/geo/aireDAttractionDesVilles2020/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans l'aire d'attraction", + "operationId": "getcogaavdesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'aire d'attraction (trois chiffres)", + "required": true, + "schema": { + "pattern": "[a-zA-Z0-9]{3}", + "type": "string", + "example": "002" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans l'aire d'attraction active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "ArrondissementMunicipal" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Aire d'attraction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/airesDAttractionDesVilles2020": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les aires d'attractions actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogaavliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les aire d'attractions actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Aire d'attraction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AireDAttractionDesVilles2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/AireDAttractionDesVilles2020" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent l'arrondissement", + "operationId": "getcogarrasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "674" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant l'arrondissement actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un arrondissement français identifié par son code (trois ou quatre caractères)", + "operationId": "getcogarr", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "674" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer l'arrondissement actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans l'arrondissement", + "operationId": "getcogarrdesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "674" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans l'arrondissement actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + }, + "example": "CommuneDeleguee" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/arrondissements": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur tous les arrondissements actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogarrliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les arrondissements actifs à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissements qui précèdent l'arrondissement", + "operationId": "getcogarrprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "674" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissements qui résultent de la projection de l'arrondissement à la date passée en paramètre. ", + "operationId": "getcogarrproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "674" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée l'arrondissement. Paramètre obligatoire (erreur 400 si absent, Format : 'AAAA-MM-JJ')", + "required": true, + "schema": { + "type": "string", + "format": "date" + }, + "example": "1994-07-30" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + } + } + } + } + } + }, + "/geo/arrondissement/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissements qui succèdent à l'arrondissement", + "operationId": "getcogarrsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement (trois ou quatre caractères)", + "required": true, + "schema": { + "pattern": "(([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6]))[0-9]", + "type": "string", + "example": "042" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "2016-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Arrondissement" + } + } + } + } + } + } + }, + "/geo/arrondissementMunicipal/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent l'arrondissement municipal", + "operationId": "getcogarrmunasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement municipal (cinq caractères)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant l'arrondissement municipal actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/arrondissementMunicipal/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un arrondissement municipal identifié par son code (cinq caractères)", + "operationId": "getcogarrmun", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement municipal (cinq caractères)", + "required": true, + "schema": { + "type": "string", + "example": "69385" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la arrondissement municipal actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + } + } + } + } + } + }, + "/geo/arrondissementsMunicipaux": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur tous les arrondissements municipaux actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogarrmunliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la arrondissement municipal actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + } + } + } + } + } + }, + "/geo/arrondissementMunicipal/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissement municipaux qui précèdent l'arrondissement municipal", + "operationId": "getcogarrmunprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement municipal (cinq caractères)", + "required": true, + "schema": { + "type": "string" + }, + "example": 69385 + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement municipal de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + } + } + } + } + } + }, + "/geo/arrondissementMunicipal/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissements municipaux qui résultent de la projection de l'arrondissement municipal à la date passée en paramètre. ", + "operationId": "getcogarrmunproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement municipal (cinq caractères)", + "required": true, + "schema": { + "type": "string", + "example": "69385" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement municipal de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "1960-01-01" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée l'arrondissement municipal. Paramètre obligatoire (erreur 400 si absent, Format : 'AAAA-MM-JJ'))", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2011-12-31" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + } + } + } + } + } + }, + "/geo/arrondissementMunicipal/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les arrondissements municipaux qui succèdent à l'arrondissement municipal", + "operationId": "getcogarrmunsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'arrondissement municipal (cinq caractères)", + "required": true, + "schema": { + "type": "string" + }, + "example": 69385 + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'arrondissement municipal de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + }, + "example": "1960-01-01" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Arrondissement municipal", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ArrondissementMunicipal" + } + } + } + } + } + } + }, + "/geo/bassinDeVie2022/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un bassin de vie identifiée par son code (neuf caractères)", + "operationId": "getcogBassinDevie2022", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du bassin de vie (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "01004" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer le bassin de vie active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "bassin de vie 2022", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BassinDeVie2022" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/BassinDeVie2022" + } + } + } + } + } + } + }, + "/geo/bassinDeVie2022/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans le bassin de vie", + "operationId": "getcogBassinDevie2022desc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du bassin de vie (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "35176" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans le bassin de vie actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "Commune" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "bassin de vie 2022", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/bassinsDeVie2022": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur tous les bassins de vie actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogBassinDevie2022liste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les bassins de vie à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom de l'intercommunalité", + "schema": { + "type": "string", + "example": "Ambérieu-en-Bugey" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "bassin de vie 2022", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BassinDeVie2022" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/BassinDeVie2022" + } + } + } + } + } + } + }, + "/geo/canton/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent le canton", + "operationId": "getcogcantonasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant le canton actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/canton/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un canton identifié par son code (quatre chiffres pour la métropole ou cinq pour les DOM ou 2A/2B plus deux chiffres pour la Corse)", + "operationId": "getcogcanton", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la region active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/canton/{code}/communes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Récupérer les informations concernant les communes qui ont un territoire commun avec le canton {code}\n", + "operationId": "getcogcantoncommunes", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "La requête renvoie les communes actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/cantons": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les cantons actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcantonliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les cantons actifs à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/canton/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les cantons qui précèdent le canton", + "operationId": "getcogcantonprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0103" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/canton/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les cantons qui résultent de la projection du canton à la date passée en paramètre. ", + "operationId": "getcogcantonproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0103" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée le canton. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2020-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/canton/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les cantons qui succèdent au canton", + "operationId": "getcogcantonsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du canton (quatre chiffres pour la Métropole ou cinq chiffres pour les DOM ou 2A/2B plus 2 chiffres pour la Corse)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0103" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "2020-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Canton", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent le canton-ou-ville", + "operationId": "getcogcantonouvilleasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant le canton-ou-ville actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un canton-ou-ville identifié par son code (quatre chiffres pour la métropole ou cinq pour les DOM)", + "operationId": "getcogcantonouville", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer le canton-ou-ville actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans le canton-ou-ville", + "operationId": "getcogcantonouvilledesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0101" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans le canton-ou-ville actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom des territoires renvoyés", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/cantonsEtVilles": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les cantons-et-villes actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcantonouvilleliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les cantons-ou-villes actifs à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les cantons-ou-villes qui précèdent le canton-ou-ville", + "operationId": "getcogcantonouvilleprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0104" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton-ou-ville de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les cantons-ou-villes qui résultent de la projection de la région à la date passée en paramètre. ", + "operationId": "getcogcantonouvilleproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0104" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton-ou-ville de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée le canton-ou-ville. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2016-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + } + } + } + } + } + }, + "/geo/cantonOuVille/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les régions qui succèdent à la région", + "operationId": "getcogcantonouvillesuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code d'un canton-ou-ville' (quatre ou cinq caractères pour les DOM ex: 97602)", + "required": true, + "schema": { + "pattern": "(([0-9]{2})|(2[0-9AB])|(97[1-6]))([0-9]{2})", + "type": "string", + "example": "0103" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le canton-ou-ville de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "2016-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "CantonOuVille", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CantonOuVille" + } + } + } + } + } + } + }, + "/geo/circonscriptionTerritoriale/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent la circonscription territoriale", + "operationId": "getcogdistrictasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la circonscription territoriale (cinq caractères)", + "required": true, + "schema": { + "pattern": "986[1-3]{2}", + "type": "string", + "example": "98611" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant la circonscription territoriale actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "circonscription territoriale d'une collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/circonscriptionTerritoriale/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une circonscription territoriale identifiée par son code (cinq caractères)", + "operationId": "getcogdistrict", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la circonscription territoriale (cinq caractères)", + "required": true, + "schema": { + "pattern": "986[1-3]{2}", + "type": "string", + "example": "98611" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la circonscription territoriale active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "circonscription territoriale d'une collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CirconscriptionTerritoriale" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CirconscriptionTerritoriale" + } + } + } + } + } + } + }, + "/geo/collectiviteDOutreMer/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une collectivité d'outre-mer identifiée par son code (cinq caractères)", + "operationId": "getcogcom", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la collectivité d'outre-mer (trois caractères)", + "required": true, + "schema": { + "pattern": "9[78][1-9]", + "type": "string", + "example": "988" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la collectivite d'outre-mer active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectiviteDOutreMer" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CollectiviteDOutreMer" + } + } + } + } + } + } + }, + "/geo/collectiviteDOutreMer/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans la collectivite d'outre-mer", + "operationId": "getcogcomdesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "code de la collectivité d'outre-mer (3 caractères)", + "required": true, + "schema": { + "pattern": "9[78][1-9]", + "type": "string", + "example": "988" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans la collectivité d'outre-mer active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.(Commune ou District)", + "schema": { + "type": "string" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom du ou des territoires renvoyés", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/collectivitesDOutreMer": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les collectivités d'outre-mer actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcomliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les collectivités d'outre-mer actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/commune/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent la commune", + "operationId": "getcogcomasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "73035" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant la commune active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/commune/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une commune française identifiée par son code (cinq caractères)", + "operationId": "getcogcom_1", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14475" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la commune active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/commune/{code}/cantons": { + "get": { + "tags": [ + "geographie" + ], + "summary": "information sur le(s) canton(s) associé(s) à la commune identifiée par son code (cinq caractères)", + "operationId": "getComCanton", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "01053" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la commune active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Cantons dont fait partie la commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Canton" + } + } + } + } + } + } + }, + "/geo/commune/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans la commune", + "operationId": "getcogcomdesc_1", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "13055" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans la commune active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "ArrondissementMunicipal" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/communes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les communes actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcomliste_1", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les communes actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom de la commune", + "schema": { + "type": "string", + "example": "Bonnay" + } + }, + { + "name": "com", + "in": "query", + "description": "Sélectionner \"true\" pour inclure les collectivités d’outre-mer", + "schema": { + "type": "boolean", + "example": false, + "enum": [ + true, + false + ], + "default": false + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/commune/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les communes qui précèdent la commune", + "operationId": "getcogcomprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14475" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la commune de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/commune/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les communes qui résultent de la projection de la commune à la date passée en paramètre.", + "operationId": "getcogcomproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14475" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la commune de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée la commune. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "1945-06-26" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/commune/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les communes qui succèdent à la commune", + "operationId": "getcogcomsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14475" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la commune de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "1945-06-26" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/communeAssociee/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent la commune associée", + "operationId": "getcogcomassasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune associée (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14463" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant la commune associée active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune associée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/communeAssociee/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une commune associée identifiée par son code (cinq caractères)", + "operationId": "getcogcomass", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune associée (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "14463" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la commune associée active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune associée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommuneAssociee" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommuneAssociee" + } + } + } + } + } + } + }, + "/geo/communesAssociees": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les communes associées actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcomassliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les communes associées actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune associée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/communeDeleguee/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent la commune déléguée", + "operationId": "getcogcomdelasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune déléguée (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "46248" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant la commune déléguée active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune déléguée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/communeDeleguee/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une commune déléguée identifiée par son code (cinq caractères)", + "operationId": "getcogcomdel", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la commune déléguée (cinq caractères)", + "required": true, + "schema": { + "pattern": "[0-9][0-9AB][0-9]{3}", + "type": "string", + "example": "46248" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la commune déléguée active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune déléguée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommuneDeleguee" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/CommuneDeleguee" + } + } + } + } + } + } + }, + "/geo/communesDeleguees": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les communes déléguées actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogcomdelliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les communes déléguées actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Commune déléguée", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + } + } + }, + "/geo/departement/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent le département", + "operationId": "getcogdepasc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant le département actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/departement/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un departement identifié par son code (deux ou trois caractères)", + "operationId": "getcogdep", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la département actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + } + } + }, + "/geo/departement/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans le departement", + "operationId": "getcogdepdesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans le département actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom des territoires renvoyés", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/departements": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur tous les départements actifs à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogdepliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer le département actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + } + } + }, + "/geo/departement/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les departements qui précèdent le departement", + "operationId": "getcogdepprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le departement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + } + } + }, + "/geo/departement/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les départements qui résultent de la projection du département à la date passée en paramètre. ", + "operationId": "getcogdepproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le departement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée le departement. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "1950-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + } + } + }, + "/geo/departement/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les départements qui succèdent au département", + "operationId": "getcogdepsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du département (deux ou trois caractères)", + "required": true, + "schema": { + "pattern": "([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])", + "type": "string", + "example": "22" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser le departement de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "1950-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Departement", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + } + } + }, + "/geo/district/{code}/ascendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires qui contiennent le district", + "operationId": "getcogdistrictasc_1", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du district (cinq caractères)", + "required": true, + "schema": { + "pattern": "9[78][1-9]{3}", + "type": "string", + "example": "98411" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires contenant le district actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "district d'une collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/district/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur un district identifiée par son code (cinq caractères)", + "operationId": "getcogdistrict_1", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du district (cinq caractères)", + "required": true, + "schema": { + "pattern": "9[78][1-9]{3}", + "type": "string", + "example": "98411" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer le district actif à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "district d'une collectivité d'outre-mer", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/District" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/District" + } + } + } + } + } + } + }, + "/geo/intercommunalite/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les intercommunalités qui précèdent l’intercommunalité", + "operationId": "getcogIntercoprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'intercommunalité (neuf caractères)", + "required": true, + "schema": { + "pattern": "2[0-4][0-9]{7}", + "type": "string", + "example": "200046977" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les informations concernant les intercommunalités qui précèdent l’intercommunalité à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/intercommunalite/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une intercommunalité identifiée par son code (neuf caractères)", + "operationId": "getcogInterco", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'intercommunalité (neuf caractères)", + "required": true, + "schema": { + "pattern": "2[0-4][0-9]{7}", + "type": "string", + "example": "240100883" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer l'intercommunalité active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + } + } + } + } + } + }, + "/geo/intercommunalite/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans l'intercommunalite", + "operationId": "getcogIntercodesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'intercommunalité (neuf caractères)", + "required": true, + "schema": { + "pattern": "2[0-4][0-9]{7}", + "type": "string", + "example": "200000438" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans l'intercommunalité active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "Commune" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/intercommunalites": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les intercommunalités actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogIntercoliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les intercommunalités à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom de l'intercommunalité", + "schema": { + "type": "string", + "example": "Plaine de l'Ain" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + } + } + } + } + } + }, + "/geo/intercommunalite/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les intercommunalites qui résultent de la projection de l'intercommunalité à la date passée en paramètre. ", + "operationId": "getcogIntercoproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'intercommunalité (neuf caractères)", + "required": true, + "schema": { + "pattern": "2[0-4][0-9]{7}", + "type": "string", + "example": "200046977" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'intercommunalité de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée l'intercommunalité. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2013-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + } + } + } + } + } + }, + "/geo/intercommunalite/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les intercommunalités qui succèdent à l'intercommunalite", + "operationId": "getcogIntercosuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'intercommunalité (neuf caractères)", + "required": true, + "schema": { + "pattern": "2[0-4][0-9]{7}", + "type": "string", + "example": "246900245" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser l'intercommunalité de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "2014-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "intercommunalité", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Intercommunalite" + } + } + } + } + } + } + }, + "/geo/region/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une région identifiée par son code (deux chiffres)", + "operationId": "getcogreg", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la région (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string", + "example": "06" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la region active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Region" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Region" + } + } + } + } + } + } + }, + "/geo/region/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans la région", + "operationId": "getcogregdesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la région (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string", + "example": "06" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans la région active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string" + } + }, + { + "name": "filtreNom", + "in": "query", + "description": "Filtre sur le nom des territoires renvoyés", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/regions": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les régions actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogregliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les régions actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Region" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Region" + } + } + } + } + } + } + }, + "/geo/region/{code}/precedents": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les régions qui précèdent la région", + "operationId": "getcogregprec", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la région (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string", + "example": "44" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la region de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Region" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Region" + } + } + } + } + } + } + }, + "/geo/region/{code}/projetes": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les regions qui résultent de la projection de la région à la date passée en paramètre. ", + "operationId": "getcogregproj", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la région (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string", + "example": "44" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la region de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dateProjection", + "in": "query", + "description": "Date vers laquelle est projetée la region. Paramètre obligatoire (Format : 'AAAA-MM-JJ', erreur 400 si absent)", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2000-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Region" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Region" + } + } + } + } + } + } + }, + "/geo/region/{code}/suivants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les régions qui succèdent à la région", + "operationId": "getcogregsuiv", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la région (deux chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{2}", + "type": "string", + "example": "41" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour préciser la region de départ. Par défaut, c’est la date courante qui est utilisée. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date", + "example": "2000-01-01" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Region", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Region" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Region" + } + } + } + } + } + } + }, + "/geo/uniteUrbaine2020/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une unité urbaine française identifiée par son code (cinq chiffres ou 1 chiffre, 1 lettre et 3 chiffres)", + "operationId": "getcoguu", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'unité urbaine (cinq chiffres)", + "required": true, + "schema": { + "pattern": "[0-9][a-zA-Z0-9][0-9]{3}", + "type": "string", + "example": "01121" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer l'unité urbaine active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Unité urbaine", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UniteUrbaine2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/UniteUrbaine2020" + } + } + } + } + } + } + }, + "/geo/uniteUrbaine2020/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans l'unité urbaine", + "operationId": "getcoguudesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'unité urbaine (cinq chiffres)", + "required": true, + "schema": { + "pattern": "[0-9][a-zA-Z0-9][0-9]{3}", + "type": "string", + "example": "01121" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans l'unité urbaine active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "ArrondissementMunicipal" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Unité urbaine", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/unitesUrbaines2020": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les unités urbaines actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcoguuliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les unités urbaines actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Unité urbaine", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UniteUrbaine2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/UniteUrbaine2020" + } + } + } + } + } + } + }, + "/geo/zoneDEmploi2020/{code}": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur une zone d'emploi française identifiée par son code (quatre chiffres)", + "operationId": "getcogze", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la zone d'emploi (quatre chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{4}", + "type": "string", + "example": "2415" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer la zone d'emploi active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Zone d'emploi", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ZoneDEmploi2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ZoneDEmploi2020" + } + } + } + } + } + } + }, + "/geo/zoneDEmploi2020/{code}/descendants": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations concernant les territoires inclus dans la zone d'emploi", + "operationId": "getcogzedesc", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de la zone d'emploi (quatre chiffres)", + "required": true, + "schema": { + "pattern": "[0-9]{4}", + "type": "string", + "example": "2415" + } + }, + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les territoires inclus dans la zone d'emploi active à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ')", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "type", + "in": "query", + "description": "Filtre sur le type de territoire renvoyé.", + "schema": { + "type": "string", + "example": "ArrondissementMunicipal" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Zone d'emploi", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + } + } + } + }, + "/geo/zonesDEmploi2020": { + "get": { + "tags": [ + "geographie" + ], + "summary": "Informations sur toutes les zones d'emploi actives à la date donnée. Par défaut, c’est la date courante.", + "operationId": "getcogzeliste", + "parameters": [ + { + "name": "date", + "in": "query", + "description": "Filtre pour renvoyer les zones d'emploi actives à la date donnée. Par défaut, c’est la date courante. (Format : 'AAAA-MM-JJ'). Le paramètre '*' permet de renvoyer tout l'historique.", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Zone d'emploi", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ZoneDEmploi2020" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ZoneDEmploi2020" + } + } + } + } + } + } + }, + "/operations/rapportQualite/{id}": { + "get": { + "tags": [ + "operations" + ], + "summary": "Documentation d'une opération, d'un indicateur ou d'une série", + "operationId": "getDocumentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifiant de la documentation (format : [0-9]{4})", + "required": true, + "schema": { + "pattern": "[0-9]{4}", + "type": "string" + }, + "example": 1979 + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Documentation SIMS", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentationSims" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/DocumentationSims" + } + } + } + } + } + } + }, + "/operations/indicateur/{idIndicateur}": { + "get": { + "tags": [ + "operations" + ], + "summary": "Informations sur un indicateur de l'Insee", + "operationId": "getIndicateur", + "parameters": [ + { + "name": "idIndicateur", + "in": "path", + "description": "Identifiant de l'indicateur (format : p[0-9]{4})", + "required": true, + "schema": { + "pattern": "p[0-9]{4}", + "type": "string" + }, + "example": "p1670" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Indicateur", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Indicateur" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Indicateur" + } + } + } + } + } + } + }, + "/operations/arborescence": { + "get": { + "tags": [ + "operations" + ], + "summary": "Liste des opérations disponibles dans leur arborescence", + "operationId": "getSeries", + "parameters": [ + { + "name": "diffuseur", + "in": "query", + "description": "Le diffuseur des données (permet de filtrer les opérations retournées)", + "schema": { + "type": "string", + "nullable": true, + "enum": [ + "insee.fr" + ] + } + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Familles", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Familles" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Familles" + } + } + } + } + } + } + }, + "/operations/serie/{idSeries}": { + "get": { + "tags": [ + "operations" + ], + "summary": "Informations sur une série statistique de l'Insee", + "operationId": "getSeries_1", + "parameters": [ + { + "name": "idSeries", + "in": "path", + "description": "Identifiant de la série(format : s[0-9]{4})", + "required": true, + "schema": { + "pattern": "s[0-9]{4}", + "type": "string" + }, + "example": "s1223" + } + ], + "responses": { + "200": { + "description": "Opération réussie" + }, + "400": { + "description": "La syntaxe de la requête est incorrecte" + }, + "401": { + "description": "Une authentification est nécessaire pour accéder à la ressource" + }, + "404": { + "description": "Ressource non trouvée" + }, + "406": { + "description": "L'en-tête HTTP 'Accept' contient une valeur non acceptée" + }, + "500": { + "description": "Erreur interne du serveur" + }, + "default": { + "description": "Séries", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Serie" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Serie" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "CategorieJuridiqueNiveauII": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "10", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/codes/cj/n2/10", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "Entrepreneur individuel", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une catégorie juridique (niveau 2)", + "xml": { + "name": "CategorieJuridiqueNiveauII" + } + }, + "CategorieJuridiqueNiveauIII": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "7112", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/codes/cj/n3/7112", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "Autorité administrative ou publique indépendante", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une catégorie juridique détaillée (niveau 3)", + "xml": { + "name": "CategorieJuridiqueNiveauIII" + } + }, + "ClasseNAF2008": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "46.66", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/codes/nafr2/classe/46.66", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "Commerce de gros d'autres machines et équipements de bureau", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une classe de la NAF 2008 (rév. 2)", + "xml": { + "name": "ClasseNAF2008" + } + }, + "SousClasseNAF2008": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "27.40Z", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/codes/nafr2/sousClasse/27.40Z", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "Fabrication d'appareils d'éclairage électrique", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une sous-classe de la NAF 2008 (rév. 2)", + "xml": { + "name": "SousClasseNAF2008" + } + }, + "ConceptLink": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "typeOfLink": { + "type": "string" + } + } + }, + "ConceptPrecedent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "c1501" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/concepts/definition/c1501" + } + }, + "description": "concept lié", + "xml": { + "name": "ConceptPrecedent" + } + }, + "ConceptSuivant": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "c1500" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/concepts/definition/c1500" + } + }, + "description": "concept lié", + "xml": { + "name": "ConceptSuivant" + } + }, + "Definition": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "c2066", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/concepts/definition/c2066", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "array", + "xml": { + "name": "Intitule" + }, + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "definition": { + "type": "array", + "xml": { + "name": "Definition" + }, + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteEditoriale": { + "type": "array", + "xml": { + "name": "NoteEditoriale" + }, + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "dateMiseAJour": { + "pattern": "AAAA-MM-JJ", + "type": "string", + "example": "2020-11-10", + "xml": { + "name": "DateMiseAJour" + } + }, + "intituleFr": { + "type": "string", + "writeOnly": true + }, + "intituleEn": { + "type": "string", + "writeOnly": true + }, + "links": { + "type": "array", + "writeOnly": true, + "items": { + "$ref": "#/components/schemas/ConceptLink" + } + }, + "definitionEn": { + "type": "string", + "writeOnly": true + }, + "scopeNoteFr": { + "type": "string", + "writeOnly": true + }, + "scopeNoteEn": { + "type": "string", + "writeOnly": true + }, + "editorialNoteFr": { + "type": "string", + "writeOnly": true + }, + "editorialNoteEn": { + "type": "string", + "writeOnly": true + }, + "definitionCourte": { + "type": "array", + "xml": { + "name": "DefinitionCourte" + }, + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "hasLink": { + "type": "boolean", + "writeOnly": true + }, + "conceptsPrecedents": { + "type": "array", + "xml": { + "name": "ConceptsPrecedents", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/ConceptPrecedent" + } + }, + "conceptsSuivants": { + "type": "array", + "xml": { + "name": "ConceptsSuivants", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/ConceptSuivant" + } + }, + "definitionFr": { + "type": "string", + "writeOnly": true + } + }, + "description": "Objet représentant la définition d'un concept statistique de l'Insee", + "xml": { + "name": "Definition" + } + }, + "TexteMultiLangue": { + "type": "object", + "properties": { + "contenu": { + "type": "string", + "example": "Texte en français" + }, + "langue": { + "type": "string", + "example": "fr", + "xml": { + "attribute": true + } + } + }, + "description": "TexteMultiLangue" + }, + "Definitions": { + "type": "object", + "properties": { + "concepts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IntituleDefinition" + } + } + }, + "description": "Tableau représentant des définitions de concepts statistiques de l'Insee" + }, + "IntituleDefinition": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "c2066", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/concepts/definition/c2066", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "Intitulé du concept à définir", + "xml": { + "name": "Intitule" + } + }, + "links": { + "type": "array", + "writeOnly": true, + "items": { + "$ref": "#/components/schemas/ConceptLink" + } + }, + "conceptsPrecedents": { + "type": "array", + "xml": { + "name": "ConceptsPrecedents", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/ConceptPrecedent" + } + }, + "conceptsSuivants": { + "type": "array", + "xml": { + "name": "ConceptsSuivants", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/ConceptSuivant" + } + }, + "hasLink": { + "type": "boolean", + "writeOnly": true + } + }, + "description": "Objet représentant la définition d'un concept statistique de l'Insee", + "xml": { + "name": "Definition" + } + }, + "Country": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "99254", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/pays/99254", + "xml": { + "attribute": true + } + }, + "intitule": { + "type": "string", + "example": "CHYPRE", + "xml": { + "name": "Intitule" + } + }, + "intituleEntier": { + "type": "string", + "example": "RÉPUBLIQUE DE CHYPRE", + "xml": { + "name": "IntituleEntier" + } + } + }, + "description": "Objet représentant un pays", + "xml": { + "name": "Pays" + } + }, + "AireDAttractionDesVilles2020": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "062", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/aireDAttractionDesVilles2020/062", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Aire d'attraction", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de l'aire d'attraction si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de l'aire d'attraction si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Angoulême", + "xml": { + "name": "Intitule" + } + } + } + }, + "IntituleSansArticle": { + "type": "object", + "properties": { + "intituleSansArticle": { + "type": "string" + }, + "typeArticle": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "xml": { + "name": "IntituleSansaArticle" + } + }, + "IntituleSansArticleRegion": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Bourgogne-Franche-Comté" + }, + "typeArticle": { + "type": "string", + "example": "0", + "xml": { + "attribute": true + } + } + } + }, + "IntituleSansArticleUniteUrbaine": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Jujurieux" + }, + "typeArticle": { + "type": "string", + "example": "0", + "xml": { + "attribute": true + } + } + } + }, + "IntituleSansArticleZoneEmploi": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Vierzon" + }, + "typeArticle": { + "type": "string", + "example": "0", + "xml": { + "attribute": true + } + } + } + }, + "IntituleSansArticleInterco": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Plaine de l'Ain" + }, + "typeArticle": { + "type": "string", + "example": "3", + "xml": { + "attribute": true + } + } + } + }, + "IntituleSansArticleDistrict": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Archipel des Kerguelen" + }, + "typeArticle": { + "type": "string", + "example": "5", + "xml": { + "attribute": true + } + } + } + }, + "IntituleSansArticleDepartement": { + "type": "object", + "xml": { + "name": "IntituleSansArticle" + }, + "properties": { + "intituleSansArticle": { + "type": "string", + "example": "Côtes-d'Armor" + }, + "typeArticle": { + "type": "string", + "example": "4", + "xml": { + "attribute": true + } + } + } + }, + "Territoire": { + "type": "object", + "properties": { + "code": { + "type": "string", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "example": "1992-09-09", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "example": "2015-10-10", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "xml": { + "name": "ChefLieu" + } + }, + "categorieJuridique": { + "type": "string", + "xml": { + "name": "CategorieJuridique" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "xml": { + "name": "Intitule" + } + } + }, + "xml": { + "name": "Territoire" + } + }, + "Arrondissement": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "191", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/arrondissement/c38af455-45e1-4f44-9d58-165e1626441a", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Arrondissement", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de l'arrondissement s'il n’existait pas au premier COG du 1er janvier 1943", + "example": "1993-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de l'arrondissement s'il a été supprimé. ", + "example": "2017-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "description": "Code Insee de la commune sous-préfecture de l’arrondissement.", + "example": "19031", + "xml": { + "name": "ChefLieu" + } + }, + "categorieJuridique": { + "type": "string", + "xml": { + "name": "CategorieJuridique" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Brive-la-Gaillarde", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant un arrondissement", + "xml": { + "name": "Arrondissement" + } + }, + "ArrondissementMunicipal": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "69388", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/arrondissementMunicipal/0b5aef6b-ee47-4cd0-ad4a-7a745dd62b3f", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "ArrondissementMunicipal", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de l'arrondissement municipal s'il n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de l'arrondissement municipal s'il a été supprimé. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "xml": { + "name": "ChefLieu" + } + }, + "categorieJuridique": { + "type": "string", + "xml": { + "name": "CategorieJuridique" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Lyon 8e Arrondissement", + "xml": { + "name": "Intitule" + } + } + }, + "xml": { + "name": "ArrondissementMunicipal" + } + }, + "BassinDeVie2022": { + "type": "object", + "properties": { + "code": { + "type": "string", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "example": "1992-09-09", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "example": "2015-10-10", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant un bassin de vie", + "xml": { + "name": "BassinDeVie2022" + } + }, + "Canton": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "0101", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "description": "URI du canton", + "example": "http://id.insee.fr/geo/canton/f96a2438-478f-4ebb-b659-434305dff18f", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Canton", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création du canton si il n’existait pas au premier COG du 1er janvier 2016", + "example": "2016-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression du canton si il a été supprimé. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "chefLieu": { + "type": "string", + "description": "Code Insee de la commune bureau centralisateur du canton. \n", + "example": "19031", + "xml": { + "name": "ChefLieu" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "description": "Nom du canton (avec article)", + "example": "Ambérieu-en-Bugey", + "xml": { + "name": "Intitule" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + } + }, + "description": "Objet représentant un canton", + "xml": { + "name": "Canton" + } + }, + "CantonOuVille": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "0101", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/cantonOuVille/0101", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "CantonOuVille", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création du canton si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "2016-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression du canton si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Ambérieu-en-Bugey", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant un cantonOuVille", + "xml": { + "name": "CantonOuVille" + } + }, + "CirconscriptionTerritoriale": { + "type": "object", + "properties": { + "code": { + "type": "string", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "example": "1992-09-09", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "example": "2015-10-10", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une circonscription territoriale", + "xml": { + "name": "CirconscriptionTerritoriale" + } + }, + "CollectiviteDOutreMer": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "98735", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/commune/98735", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Commune", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la commune/district si il/elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la commune/district si il/elle a été supprimé(e). ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Papeete", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une collectivite d'outre-mer", + "xml": { + "name": "CollectiviteDOutreMER" + } + }, + "Commune": { + "required": [ + "inclusion" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "55323", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/commune/55323", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Commune", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la commune si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la commune si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "inclusion": { + "type": "string", + "description": "inclusion totale ou partielle dans un canton", + "example": "totale", + "enum": [ + "partielle", + "totale" + ] + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "L'Aigle", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une commune", + "xml": { + "name": "Commune" + } + }, + "CommuneAssociee": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "14463", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/communeAssociee/14463", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Commune Associee", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la commune si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la commune si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "xml": { + "name": "ChefLieu" + } + }, + "categorieJuridique": { + "type": "string", + "xml": { + "name": "CategorieJuridique" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Neuilly-le-Malherbe", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une commune associee", + "xml": { + "name": "CommuneAssociee" + } + }, + "CommuneDeleguee": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "46248", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/communeDeleguee/46248", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Commune Deleguee", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la commune si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la commune si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "xml": { + "name": "ChefLieu" + } + }, + "categorieJuridique": { + "type": "string", + "xml": { + "name": "CategorieJuridique" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "L'Aigle", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une commune deleguee", + "xml": { + "name": "CommuneDeleguee" + } + }, + "Departement": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "22", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/departement/22", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Departement", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création du département si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1990-03-08", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression du département si elle a été supprimée. ", + "example": "string", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticleDepartement" + }, + "chefLieu": { + "type": "string", + "description": "Code Insee de la commune préfecture du département.", + "example": "22278", + "xml": { + "name": "ChefLieu" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Côtes-d'Armor", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant un departement", + "xml": { + "name": "Departement" + } + }, + "District": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "98412", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/district/78c18c16-2d63-486d-9ff0-e36e76a95718", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "District", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création du district s'il n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression du district s'il a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticleDistrict" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Archipel des Kerguelen", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant un district", + "xml": { + "name": "District" + } + }, + "Intercommunalite": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": 240100883, + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/intercommunalite/5a238840-5cbd-469f-80c8-43713bf8e4a8", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Intercommunalite", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "example": "2017-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticleInterco" + }, + "categorieJuridique": { + "type": "string", + "example": "Communauté de communes", + "xml": { + "name": "CategorieJuridique" + } + }, + "intituleComplet": { + "type": "string", + "example": "Communauté de communes de La Plaine de l'Ain", + "xml": { + "name": "IntituleComplet" + } + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "La Plaine de l'Ain", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une intercommunalite", + "xml": { + "name": "Intercommunalite" + } + }, + "Region": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "27", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la région si elle n’existait pas au premier COG du 1er janvier 1943", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la région si elle a été supprimée. ", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "chefLieu": { + "type": "string", + "description": "Code Insee de la commune préfecture de la région", + "xml": { + "name": "ChefLieu" + } + }, + "typeArticle": { + "type": "string" + }, + "intitule": { + "type": "string", + "xml": { + "name": "Intitule" + } + } + }, + "example": { + "code": 27, + "uri": "http://id.insee.fr/geo/region/c1c47bc9-6676-41e7-bdef-7136469f95f4", + "intitule": "Bourgogne-Franche-Comté", + "type": "Region", + "dateCreation": "2016-01-01T00:00:00.000Z", + "IntituleSansArticle": "Bourgogne-Franche-Comté", + "typeArticle": 0, + "chefLieu": 21231 + }, + "description": "Objet représentant une région", + "xml": { + "name": "Region" + } + }, + "UniteUrbaine2020": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "01121", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/uniteUrbaine2020/57a37c9b-e426-430e-b8c1-ac0fd640e345", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "UniteUrbaine2020", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de l'unité urbaine si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "2020-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de l'unité urbaine si elle a été supprimée. ", + "example": "string", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticleUniteUrbaine" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Jujurieux", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une unité urbaine", + "xml": { + "name": "UniteUrbaine2020" + } + }, + "ZoneDEmploi2020": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "2415", + "xml": { + "attribute": true + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/geo/zoneDEmploi2020/dbab03e7-3d8d-4797-8ab1-0ed36a4db9c1", + "xml": { + "attribute": true + } + }, + "type": { + "type": "string", + "example": "Zone d'emploi", + "xml": { + "name": "Type" + } + }, + "dateCreation": { + "type": "string", + "description": "Date de création de la zone d'emploi si elle n’existait pas au premier COG du 1er janvier 1943", + "example": "1943-01-01", + "xml": { + "name": "DateCreation" + } + }, + "dateSuppression": { + "type": "string", + "description": "Date de suppression de la zone d'emploi si elle a été supprimée. ", + "example": "2019-01-01", + "xml": { + "name": "DateSuppression" + } + }, + "intituleSansArticle": { + "$ref": "#/components/schemas/IntituleSansArticle" + }, + "typeArticle": { + "type": "string", + "writeOnly": true + }, + "intitule": { + "type": "string", + "example": "Vierzon", + "xml": { + "name": "Intitule" + } + } + }, + "description": "Objet représentant une zone d'emploi", + "xml": { + "name": "ZoneDEmploi2020" + } + }, + "Document": { + "type": "object", + "properties": { + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "dateMiseAJour": { + "type": "string" + }, + "langue": { + "type": "string" + }, + "url": { + "type": "string" + }, + "labelLg1": { + "type": "string", + "writeOnly": true + }, + "labelLg2": { + "type": "string", + "writeOnly": true + } + } + }, + "DocumentationSims": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/qualite/attribut/1907/I.18.11" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "cible": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "rubriques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rubrique" + } + }, + "labelLg1": { + "type": "string", + "writeOnly": true + }, + "labelLg2": { + "type": "string", + "writeOnly": true + }, + "idCible": { + "type": "string", + "writeOnly": true + }, + "labelCibleLg1": { + "type": "string", + "writeOnly": true + }, + "labelCibleLg2": { + "type": "string", + "writeOnly": true + } + } + }, + "ObjetSimple": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/..." + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + } + }, + "description": "Objet simple" + }, + "Rubrique": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/qualite/attribut/1907/I.18.11" + }, + "idParent": { + "type": "string" + }, + "type": { + "type": "string" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelLg1": { + "type": "string", + "writeOnly": true + }, + "labelLg2": { + "type": "string", + "writeOnly": true + }, + "titre": { + "type": "array", + "description": "Titre de la rubrique", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "codes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "date": { + "type": "string" + }, + "organisme": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "territoire": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "contenus": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RubriqueRichText" + } + } + } + }, + "RubriqueRichText": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "texte": { + "type": "string" + }, + "langue": { + "type": "string", + "example": "fr" + } + } + }, + "Indicateur": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "p1647" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/produits/indicateur/p1647" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "indicateursPrecedents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IndicateurPrecedent" + } + }, + "indicateursSuivants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IndicateurSuivant" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "seriesContributrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Serie" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + }, + "frequenceDiffusion": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + } + } + }, + "IndicateurPrecedent": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "p1647" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/produits/indicateur/p1647" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "indicateursSuivants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IndicateurSuivant" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "seriesContributrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Serie" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + }, + "frequenceDiffusion": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + } + }, + "description": "Indicateur précédent", + "xml": { + "name": "IndicateurPrecedent" + } + }, + "IndicateurSuivant": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "p1647" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/produits/indicateur/p1647" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "seriesContributrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Serie" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + }, + "frequenceDiffusion": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + } + }, + "description": "Indicateur suivant", + "xml": { + "name": "IndicateurSuivant" + } + }, + "ObjetSimpleAvecSims": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/..." + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + } + }, + "description": "Objet simple avec documentation SIMS" + }, + "Operation": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "s1459" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/operations/operation/s1459" + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + } + }, + "description": "Objet représentant une opération statistique" + }, + "Serie": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "s1234" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/operations/serie/s1234" + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "type": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "operations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } + }, + "indicateurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Indicateur" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "famille": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "frequenceCollecte": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + }, + "seriesPrecedentes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriePrecedente" + } + }, + "seriesSuivantes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SerieSuivante" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "servicesCollecteurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Objet représentant une série d'opérations statistiques" + }, + "SeriePrecedente": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "s1234" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/operations/serie/s1234" + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "type": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "operations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "famille": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "frequenceCollecte": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + }, + "seriesSuivantes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SerieSuivante" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "servicesCollecteurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Série liée", + "xml": { + "name": "SeriePrecedente" + } + }, + "SerieSuivante": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "s1234" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/operations/serie/s1234" + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "type": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "operations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } + }, + "labelFr": { + "type": "string", + "writeOnly": true + }, + "labelEn": { + "type": "string", + "writeOnly": true + }, + "abstractLg1": { + "type": "string", + "writeOnly": true + }, + "abstractLg2": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg1": { + "type": "string", + "writeOnly": true + }, + "historyNoteLg2": { + "type": "string", + "writeOnly": true + }, + "famille": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "resume": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "noteHistorique": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "frequenceCollecte": { + "$ref": "#/components/schemas/ObjetSimple" + }, + "idRapportQualite": { + "type": "string" + }, + "simsId": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimpleAvecSims" + } + }, + "organismesResponsables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "servicesCollecteurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjetSimple" + } + }, + "proprietaires": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Série liée", + "xml": { + "name": "SerieSuivante" + } + }, + "Famille": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "s23" + }, + "label": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + }, + "uri": { + "type": "string", + "example": "http://id.insee.fr/operations/famille/s23" + }, + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Serie" + } + }, + "altLabel": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TexteMultiLangue" + } + } + }, + "description": "Objet représentant une famille d'opérations statistiques" + }, + "Familles": { + "type": "object", + "properties": { + "families": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Famille" + } + } + }, + "description": "Objet représentant l'arborescence des opérations statistiques" + } + } + } +} \ No newline at end of file diff --git a/src/main/resources/openapi.yaml b/src/main/resources/openapi.yaml new file mode 100644 index 00000000..e6b185dc --- /dev/null +++ b/src/main/resources/openapi.yaml @@ -0,0 +1,421 @@ +openapi: 3.1.0 +info: + title: API RMéS + description: API sur les métadonnées de l'Insee + version: 3.7.2 +externalDocs: + description: 'This API is is open source : the sources can be found there' + url: https://github.com/InseeFr/Metadata-API +servers: + - url: http://localhost:8080/metadata-api +tags: + # - name: nomenclatures + # description: Nomenclatures API + # - name: concepts + # description: Concepts API + # - name: operations + # description: Operations API + - name: geoDepartement + description: 'API géographie : Département' + - name: geoCommune + description: 'API géographie : Commune' + - name: geo + description: 'API géographie : Générique' +paths: + /geo/departement/{code}: + get: + tags: + - geoDepartement + summary: 'Informations sur un departement identifié par son code (deux ou trois caractères)' + operationId: 'getcogdep' + parameters: + - $ref: '#/components/parameters/dateActive' + - $ref: '#/components/parameters/codeDepInPath' + responses: + '200': + $ref: '#/components/responses/Departement200' + '400': + $ref: '#/components/responses/IncorrectRequest' + '404': + $ref: '#/components/responses/NotFound' + '406': + $ref: '#/components/responses/NotAcceptable' + '500': + $ref: '#/components/responses/ServerError' + # /geo/cantons: + /geo/departement/{code}/descendants: + get: + tags: + - geoDepartement + summary: 'Informations concernant les territoires inclus dans le departement' + operationId: 'getcogdepdesc' + parameters: + - $ref: '#/components/parameters/codeDepInPath' + - $ref: '#/components/parameters/dateActive' + - $ref: '#/components/parameters/filtreNom' + - $ref: '#/components/parameters/typeTerritoire' + responses: + '200': + $ref: '#/components/responses/Descendants200' + '400': + $ref: '#/components/responses/IncorrectRequest' + '404': + $ref: '#/components/responses/NotFound' + '406': + $ref: '#/components/responses/NotAcceptable' + '500': + $ref: '#/components/responses/ServerError' + /geo/communes: + get: + tags: + - geoCommune + description: |- + Informations sur toutes les communes actives à la date donnée. Par défaut, c'est la date courante. + operationId: 'getcogcomliste' + parameters: + - $ref: '#/components/parameters/dateActive' + - $ref: '#/components/parameters/filtreNom' + - $ref: '#/components/parameters/com' + responses: + '200': + $ref: '#/components/responses/CommuneListe200' + '400': + $ref: '#/components/responses/IncorrectRequest' + '404': + $ref: '#/components/responses/NotFound' + '406': + $ref: '#/components/responses/NotAcceptable' + '500': + $ref: '#/components/responses/ServerError' + # utiliser responses.200.links.getcogcom.operationID : getcogcom + /geo/commune/{code}: + get: + tags: + - geoCommune + summary: 'Informations sur une commune française identifiée par son code (cinq caractères)' + operationId: getcogcom + parameters: + - $ref: '#/components/parameters/codeCommuneInPath' + - $ref: '#/components/parameters/dateActive' + responses: + '200': + $ref: '#/components/responses/Commune200' + '400': + $ref: '#/components/responses/IncorrectRequest' + '404': + $ref: '#/components/responses/NotFound' + '406': + $ref: '#/components/responses/NotAcceptable' + '500': + $ref: '#/components/responses/ServerError' +components: + parameters: + codeTerritoireInPath: + name: 'code' + in: path + description: 'Code identifiant un territoire' + required: true + schema: + type: string + codeDepInPath: + name: 'code' + in: path + description: 'Code du département (deux ou trois caractères)' + required: true + schema: + $ref: '#/components/schemas/CodeDep' + codeCommuneInPath: + required: true + name: code + in: path + description: 'Code de la commune (cinq caractères)' + schema: + $ref: '#/components/schemas/CodeCom' + dateActive: + in: query + description: |- + Filtre pour renvoyer la commune active à la date donnée. Par défaut, c'est la date courante. (Format : 'AAAA-MM-JJ') + name: date + schema: + type: 'string' + format: date + typeTerritoire: + name: 'type' + in: query + description: 'Filtre sur le type de territoire renvoyé.' + schema: + $ref: '#/components/schemas/TypeEnum' + filtreNom: + name: 'filtreNom' + in: query + description: 'Filtre sur le nom de la commune' + schema: + type: string + example: 'Bonnay' + com: + name: 'com' + in: 'query' + description: |- + Sélectionner `true` pour inclure les collectivités d'outre-mer + schema: + type: boolean + default: false + example: false + examples: + CommuneXML: + externalValue: |- + + + 1943-01-01 + Commune + 5 + Abergement-de-Varey + L'Abergement-de-Varey + + CommuneListe: + value: + - code: '01002' + uri: 'http://id.insee.fr/geo/commune/43018c68-c278-433a-b285-3531e8d5347e' + dateCreation: '1943-01-01' + type: 'Commune' + typeArticle: '5' + intituleSansArticle: 'Abergement-de-Varey' + intitule: 'L''Abergement-de-Varey' + Commune: + value: + code: '01002' + uri: 'http://id.insee.fr/geo/commune/43018c68-c278-433a-b285-3531e8d5347e' + dateCreation: '1943-01-01' + type: 'Commune' + typeArticle: '5' + intituleSansArticle: 'Abergement-de-Varey' + intitule: 'L''Abergement-de-Varey' + responses: + IncorrectRequest: + description: 'La syntaxe de la requête est incorrecte' + NotFound: + description: 'Ressource non trouvée' + NotAcceptable: + description: 'L''en-tête HTTP ''Accept'' contient une valeur non acceptée' + ServerError: + description: 'Erreur interne du serveur' + Descendants200: + description: 'Opération réussie pour les descendants d''un territoire' + # links: + # territoire: + # operationId: getTerritoireByTypeAndCode + # parameters: + # typeTerritoire: $response.body#/type + # code: $response.body#/code + content: + application/json: + schema: + $ref: '#/components/schemas/ListeTerritoires' + application/xml: + schema: + $ref: '#/components/schemas/ListeTerritoires' + Departement200: + description: 'Opération réussie pour le département' + content: + application/json: + schema: + $ref: '#/components/schemas/Departement' + application/xml: + schema: + $ref: '#/components/schemas/Departement' + CommuneListe200: + description: 'Opération réussie' + content: + application/json: + schema: + $ref: '#/components/schemas/CommuneListe' + examples: + défaut: + $ref: '#/components/examples/CommuneListe' + application/xml: + schema: + $ref: '#/components/schemas/CommuneListe' + examples: + défaut: + $ref: '#/components/examples/CommuneListe' + Commune200: + description: Opération réussie + content: + application/json: + schema: + $ref: '#/components/schemas/Commune' + examples: + défaut: + $ref: '#/components/examples/Commune' + application/xml: + schema: + $ref: '#/components/schemas/Commune' + examples: + défaut: + $ref: '#/components/examples/Commune' + schemas: + CodeCom: + pattern: '[0-9][0-9AB][0-9]{3}' + type: 'string' + xml: + attribute: true + example: '14475' + CodeDep: + description: 'Code d''un département' + pattern: '([013-8][0-9])|(2[0-9AB])|(9[0-5])|(97[1-6])' + type: string + xml: + attribute: true + example: '22' + CommuneListe: + description: 'Liste de communes' + type: array + xml: + wrapped: true + name: Communes + items: + $ref: '#/components/schemas/Commune' + TypeEnum: + type: string + xml: + name: 'Type' + enum: + - Commune + - Canton + - Arrondissement + - Departement + - Region + example: 'Canton' + TerritoireBase: + type: object + required: + - code + - uri + - dateCreation + - intituleSansArticle + - typeArticle + - intitule + properties: + ###### Properties copied from TerritoireRef ! ######## + code: + type: string + description: 'Code identifiant un teritoire quelqconque' + territoireType: + $ref: '#/components/schemas/TypeEnum' + ####################################################### + uri: + type: string + pattern: uri + xml: + attribute: true + example: 'http://id.insee.fr/geo/commune/43018c68-c278-433a-b285-3531e8d5347e' + dateCreation: + type: string + description: 'Date de création du territoire s''il n''existait pas au premier COG du 1er janvier 1943' + format: date + example: '2016-01-20' + xml: + name: DateCreation + dateSuppression: + type: string + description: 'Date de supression du territoire s''il a été supprimé' + format: date + example: '2016-01-20' + xml: + name: DateSuppression + intituleSansArticle: + xml: + name: IntituleSansArticle + type: string + example: 'Teste de Buch' + typeArticle: + xml: + name: TypeArticle + type: string + enum: + - 0: + article: + charniere: 'De' + - 1: + article: + charniere: 'D''' + - 2: + article: 'Le' + charniere: 'Du' + - 3: + article: 'La' + charniere: 'De La' + - 4: + article: 'Les' + charniere: 'Des' + - 5: + article: 'L''' + charniere: 'De L''' + - 6: + article: 'Aux' + charniere: 'Des' + - 7: + article: 'Las' + charniere: 'De Las' + - 8: + article: 'Los' + charniere: 'De Los' + - X: + article: + charniere: + example: '3' + intitule: + type: string + example: 'La Teste de Buch' + xml: + name: Intitule + ListeTerritoires: + description: 'Liste de références sur des territoires' + type: array + xml: + wrapped: true + name: Territoires + items: + $ref: '#/components/schemas/TerritoireRef' + Departement: + xml: + name: Departement + allOf: + - $ref: '#/components/schemas/TerritoireBase' + properties: + code: + $ref: '#/components/schemas/CodeDep' + chefLieu: + type: object + properties: + ###### Properties copied from TerritoireRef ! ######## + code: + type: string + description: 'Code identifiant un teritoire quelconque' + territoireType: + $ref: '#/components/schemas/TypeEnum' + ####################################################### + xml: + name: ChefLieu + TerritoireRef: + xml: + name: TerritoireRef + type: object + required: + - code + - territoireType + description: 'Références vers un territoire de n''importe quel type' + properties: + code: + type: string + description: 'Code identifiant un teritoire quelqconque' + territoireType: + $ref: '#/components/schemas/TypeEnum' + Commune: + xml: + name: Commune + allOf: + - $ref: '#/components/schemas/TerritoireBase' + properties: + code: + $ref: '#/components/schemas/CodeCom'