api_geo_client

ApiGeoClient - the Ruby gem for the API Géo

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build api_geo_client.gemspec

Then either install the gem locally:

gem install ./api_geo_client-1.0.0.gem

(for development, run gem install --dev ./api_geo_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'api_geo_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'api_geo_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'api_geo_client'

api_instance = ApiGeoClient::CommunesApi.new
code = 'code_example' # String | Code INSEE de la commune
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Récupérer les informations concernant une commune
  result = api_instance.communes_code_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling CommunesApi->communes_code_get: #{e}"
end

api_instance = ApiGeoClient::CommunesApi.new
opts = { 
  code_postal: 'code_postal_example', # String | Code postal associé
  lat: 3.4, # Float | Latitude (en degrés)
  lon: 3.4, # Float | Longitude (en degrés)
  nom: 'nom_example', # String | Nom de la commune
  boost: 'boost_example', # String | Mode de boost de la recherche par nom
  code: 'code_example', # String | Code de la commune
  siren: 'siren_example', # String | Code SIREN de la commune
  code_epci: 'code_epci_example', # String | Code de l'EPCI associé
  code_departement: 'code_departement_example', # String | Code du département associé
  code_region: 'code_region_example', # String | Code de la région associée
  zone: ['zone_example'], # Array<String> | Zone permettant de filtrer à la métropole, aux DROM et aux COM. Défaut à metro,drom sauf pour les communes à metro,drom,com pour conserver le comportement historique.
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Recherche des communes
  result = api_instance.communes_get(opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling CommunesApi->communes_get: #{e}"
end

api_instance = ApiGeoClient::CommunesApi.new
code = 'code_example' # String | Code du département
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Renvoi les communes d'un département
  result = api_instance.departements_code_communes_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling CommunesApi->departements_code_communes_get: #{e}"
end

api_instance = ApiGeoClient::CommunesApi.new
code = 'code_example' # String | Code de l'EPCI
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Renvoi les communes d'un EPCI
  result = api_instance.epcis_code_communes_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling CommunesApi->epcis_code_communes_get: #{e}"
end

api_instance = ApiGeoClient::DpartementsApi.new
code = 'code_example' # String | Code du département
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Renvoi les communes d'un département
  result = api_instance.departements_code_communes_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling DpartementsApi->departements_code_communes_get: #{e}"
end

api_instance = ApiGeoClient::DpartementsApi.new
code = 'code_example' # String | Code du département
opts = { 
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Récupérer les informations concernant un département
  result = api_instance.departements_code_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling DpartementsApi->departements_code_get: #{e}"
end

api_instance = ApiGeoClient::DpartementsApi.new
opts = { 
  code: 'code_example', # String | Code du département
  code_region: 'code_region_example', # String | Code région associé
  nom: 'nom_example', # String | Nom du département
  zone: ['zone_example'], # Array<String> | Zone permettant de filtrer à la métropole, aux DROM et aux COM. Défaut à metro,drom sauf pour les communes à metro,drom,com pour conserver le comportement historique.
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Recherche des départements
  result = api_instance.departements_get(opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling DpartementsApi->departements_get: #{e}"
end

api_instance = ApiGeoClient::DpartementsApi.new
code = 'code_example' # String | Code de la région
opts = { 
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Renvoi les départements d'une région
  result = api_instance.regions_code_departements_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling DpartementsApi->regions_code_departements_get: #{e}"
end

api_instance = ApiGeoClient::EPCIApi.new
code = 'code_example' # String | Code de l'EPCI
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Renvoi les communes d'un EPCI
  result = api_instance.epcis_code_communes_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling EPCIApi->epcis_code_communes_get: #{e}"
end

api_instance = ApiGeoClient::EPCIApi.new
code = 'code_example' # String | Code INSEE de l'EPCI
opts = { 
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Récupérer les informations concernant un EPCI
  result = api_instance.epcis_code_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling EPCIApi->epcis_code_get: #{e}"
end

api_instance = ApiGeoClient::EPCIApi.new
opts = { 
  nom: 'nom_example', # String | Nom de l'EPCI
  boost: 'boost_example', # String | Mode de boost de la recherche par nom
  code_epci: 'code_epci_example', # String | Code de l'EPCI associé
  code_departement: 'code_departement_example', # String | Code du département associé
  code_region: 'code_region_example', # String | Code de la région associée
  zone: ['zone_example'], # Array<String> | Zone permettant de filtrer à la métropole, aux DROM et aux COM. Défaut à metro,drom sauf pour les communes à metro,drom,com pour conserver le comportement historique.
  fields: ['fields_example'], # Array<String> | Liste des champs souhaités dans la réponse
  format: 'json', # String | Format de réponse attendu
  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
}

begin
  #Recherche des EPCI
  result = api_instance.epcis_get(opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling EPCIApi->epcis_get: #{e}"
end

api_instance = ApiGeoClient::RgionsApi.new
code = 'code_example' # String | Code de la région
opts = { 
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Renvoi les départements d'une région
  result = api_instance.regions_code_departements_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling RgionsApi->regions_code_departements_get: #{e}"
end

api_instance = ApiGeoClient::RgionsApi.new
code = 'code_example' # String | Code de la région
opts = { 
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Récupérer les informations concernant une région
  result = api_instance.regions_code_get(code, opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling RgionsApi->regions_code_get: #{e}"
end

api_instance = ApiGeoClient::RgionsApi.new
opts = { 
  code: 'code_example', # String | Code de la région
  nom: 'nom_example', # String | Nom de la région
  zone: ['zone_example'], # Array<String> | Zone permettant de filtrer à la métropole, aux DROM et aux COM. Défaut à metro,drom sauf pour les communes à metro,drom,com pour conserver le comportement historique.
  fields: ['fields_example'] # Array<String> | Liste des champs souhaités dans la réponse
}

begin
  #Recherche des régions
  result = api_instance.regions_get(opts)
  p result
rescue ApiGeoClient::ApiError => e
  puts "Exception when calling RgionsApi->regions_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://geo.api.gouv.fr/

Class	Method	HTTP request	Description
ApiGeoClient::CommunesApi	communes_code_get	GET /communes/{code}	Récupérer les informations concernant une commune
ApiGeoClient::CommunesApi	communes_get	GET /communes	Recherche des communes
ApiGeoClient::CommunesApi	departements_code_communes_get	GET /departements/{code}/communes	Renvoi les communes d'un département
ApiGeoClient::CommunesApi	epcis_code_communes_get	GET /epcis/{code}/communes	Renvoi les communes d'un EPCI
ApiGeoClient::DpartementsApi	departements_code_communes_get	GET /departements/{code}/communes	Renvoi les communes d'un département
ApiGeoClient::DpartementsApi	departements_code_get	GET /departements/{code}	Récupérer les informations concernant un département
ApiGeoClient::DpartementsApi	departements_get	GET /departements	Recherche des départements
ApiGeoClient::DpartementsApi	regions_code_departements_get	GET /regions/{code}/departements	Renvoi les départements d'une région
ApiGeoClient::EPCIApi	epcis_code_communes_get	GET /epcis/{code}/communes	Renvoi les communes d'un EPCI
ApiGeoClient::EPCIApi	epcis_code_get	GET /epcis/{code}	Récupérer les informations concernant un EPCI
ApiGeoClient::EPCIApi	epcis_get	GET /epcis	Recherche des EPCI
ApiGeoClient::RgionsApi	regions_code_departements_get	GET /regions/{code}/departements	Renvoi les départements d'une région
ApiGeoClient::RgionsApi	regions_code_get	GET /regions/{code}	Récupérer les informations concernant une région
ApiGeoClient::RgionsApi	regions_get	GET /regions	Recherche des régions

Documentation for Models

• ApiGeoClient::Commune
• ApiGeoClient::Departement
• ApiGeoClient::Epci
• ApiGeoClient::Error
• ApiGeoClient::Region

Documentation for Authorization

All endpoints do not require authorization.