Skip to content

lutece-platform/lutece-tech-plugin-geocodes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alerte Line of code Coverage

Plugin geocodes

Introduction

The purpose of this plug-in is to provide a service to:

  • find a city or a country label according to its INSEE code and a validity date,

  • search for communes or a country on their wording (minimum 3 first letters) and a validity date, to obtain their INSEE codes

Configuration

Usage

The data is accessible through two channels:

  • a GeoCodesService java class

  • a REST service (see swagger documentation, available with the swaggerui plugin) :

  • GET /rest/geocodes/api/v1/cities?search={name}&dateref={dateref}
  • GET /rest/geocodes/api/v1/cities/list?search={name}&dateref={dateref}
  • GET /rest/geocodes/api/v1/cities/{code}&dateref={dateref}
  • GET /rest/geocodes/api/v1/countries
  • GET /rest/geocodes/api/v1/countries/{id}
  • GET /rest/geocodes/api/v1/countries/search/{str}

Maven documentation and reports

generated by xdoc2md - do not edit directly.