Commit 98d525ca authored by Christine Plumejeaud's avatar Christine Plumejeaud
Browse files

add list of admiralties and Province that can be requested

parent b5570e96
...@@ -71,56 +71,57 @@ sudo service apache2 reload ...@@ -71,56 +71,57 @@ sudo service apache2 reload
### 1.2.1. Principes ### 1.2.1. Principes
Les données exposées sont une extraction des points d'escales géolocalisés de navigocorpus pour 1787, composé à partir du registre de la santé de Marseille et des congés du G5, ainsi que les cahiers du petit cabotage sur Marseille. Ces localisations sont récupérées depuis la [base navigocorpus](http://navigocorpus.org/) (logiciel Filemaker) en ligne et téléchargées dans postgres avec le code d'un [ETL disponible dans le gitlab d'humanum](https://gitlab.huma-num.fr/portic/navigocorpus/-/tree/master/ETL). The published data are an extraction of the geolocated points of call from navigocorpus for 1787, composed from the Marseille health register and G5 holidays, as well as the small cabotage notebooks for Marseille.
These locations are retrieved from the [navigocorpus database](http://navigocorpus.org/) (Filemaker software) online, and also uploaded in a Postgres database using a program [ available for free in humanum gitlab](https://gitlab.huma-num.fr/portic/navigocorpus/-/tree/master/ETL).
URL du gazetteer : **http://gaz.portic.fr/places/** gazetteer's URL : **http://gaz.portic.fr/places/**
Trois requêtes : Three kind of requests :
- **[ports](http://gaz.portic.fr/ports)** : un fichier geojson listant tous les ports disponibles dans ce gazetteer - **[ports](http://gaz.portic.fr/ports)** : a geojson file listing all available ports in the gazetteer
- **[places](http://gaz.portic.fr/places?)** : la description en json_ld d'une place particulière définie par son Uhgs_id (identifiant unique) ou bien par son nom si Amirauté ou Province - **[places](http://gaz.portic.fr/places?)** : json_ld description of a place uniquely identified
- **[fieldnames](http://gaz.portic.fr/fieldnames)** : récupère des métadonnées sur les ports, avec la liste des attributs, avec leur nom court et long, leur type et leur signification. - **[fieldnames](http://gaz.portic.fr/fieldnames)** : look for metadata on ports and maritime places with attributes list, their name and shorten name, their type and an explanation about the meaning.
### 1.2.2. ports ### 1.2.2. ports
Export list of ports_points (in 900013 projection or what is specified by user) in json format, Export list of ports_points (in 900013 projection or what is specified by user) in json format,
with all required attributes for visualisations (selection of parameters is not possible for the moment) with all required attributes for visualisations (selection of parameters is not possible for the moment)
List of attributes : List of attributes :
**ogc_fid, uhgs_id, total, toponym, belonging_states, status, geonameid, admiralty, province, shiparea , point** **ogc_fid, uhgs_id, total, toponym, belonging_states, status, geonameid, admiralty, province, shiparea , point**
point is the geometry of the port. point is the geometry of the port.
User can get a description of the attributes by using /fieldnames?api=ports User can get a description of the attributes by using /fieldnames?api=ports
Default srid is 900913 Default srid is 900913
You get another by specifying a srid param You get another by specifying a srid param
Will be extracted from postgres, schema ports, table port_points (see navigocorpus/ETL) Will be extracted from postgres, schema ports, table port_points (see navigocorpus/ETL)
Tested alone in a browser: Tested alone in a browser:
- http://gaz.portic.fr/ports?srid=4326 - http://gaz.portic.fr/ports?srid=4326
- http://gaz.portic.fr/ports? - http://gaz.portic.fr/ports?
and by using explorex.portic.fr application (code alphaportic for visualisation) as client : it works and by using explorex.portic.fr application (code alphaportic for visualisation) as client : it works
Liste des paramètres et valeur par défaut en gras: List of possible parameters for the request, with their default value in bold :
- srid : **900013** - srid : **900013**
- format : csv | **json** - format : csv | **json**
- shortenfields : true | **false** - shortenfields : true | **false**
**srid** is the projection used to deliver the geometries. Provide a valid EPSG (present in spatial_ref_sys table with postgis 2.5) **srid** is the projection used to deliver the geometries. Provide a valid EPSG (present in spatial_ref_sys table with postgis 2.5)
**format** permet de télécharger soit au format CSV soit au format JSON les données. **format** to download data either in CSV format either in JSON format.
Par exemple : For example :
- <http://gaz.portic.fr/ports/?format=csv> - <http://gaz.portic.fr/ports/?format=csv>
Le séparateur dans le fichier CSV est le point-virgule (;) Semi-comma is the separator in CSV file (;)
Pour avoir les mêmes données en JSON : To get same data in JSON :
- <http://gaz.portic.fr/ports/?format=json> - <http://gaz.portic.fr/ports/?format=json>
**shortenfields** permet de raccourcir les noms des attributs et donc d'alléger la taille du JSON téléchargé. L'API permet de récupérer le mapping entre ces noms courts et longs avec <http://gaz.portic.fr/fieldnames/?format=json> **shortenfields** allow for shorten attribute names and thus to lighten size of downloaded data. With the API, you can have the mapping between names and shorten names : <http://gaz.portic.fr/fieldnames/?format=json>
Exemple : Example :
<http://gaz.portic.fr/ports?format=json&shortenfields=true> <http://gaz.portic.fr/ports?format=json&shortenfields=true>
Un exemplaire de ce qui peut être téléchargé est dans le GIT dans samples/ports.json Samples of what could be downloaded is in the file samples/ports.json
### 1.2.3. places ### 1.2.3. places
...@@ -129,25 +130,80 @@ Return the places using linked places model as specified in ...@@ -129,25 +130,80 @@ Return the places using linked places model as specified in
https://github.com/LinkedPasts/linked-places https://github.com/LinkedPasts/linked-places
See : http://linkedpasts.org/ontology/lpo_latest.ttl See : http://linkedpasts.org/ontology/lpo_latest.ttl
Will be extracted from postgres, schema navigoviz, table ports.port_points (see navigocorpus/ETL) Will be extracted from postgres, schema navigoviz, table ports.port_points (see navigocorpus/ETL)
You can get a province description : - You can get a province description :
http://127.0.0.1:80/places/?Flandre http://gaz.portic.fr/places/?Flandre
You can get a amiraute description : - You can get a amiraute description :
http://127.0.0.1:80/places/?Dunkerque http://gaz.portic.fr/places/?Dunkerque
You can get a port description (only by its UHGS id): - You can get a port description (only by its UHGS id):
http://127.0.0.1:80/places/?A0198999 http://gaz.portic.fr/places/?A0198999
You can go on http://explorex.portic.fr to find the UHGS id of a port present in the database, through a search form with a map to locate it. You can go on http://explorex.portic.fr to find the UHGS id of a port present in the database, through a search form with a map to locate it.
### 1.2.4. fielnames ### 1.2.4. fielnames
Récupère des métadonnées sur l'API, avec la liste des attributs, avec leur nom court et long, leur type et leur signification. Get metadata about the gazetteer with short and long name, type and definition, in English.
Get metadata about the gazetteer with short and long name, type and definition
Api is 'ports' by default.
Api is 'ports' by default.
- http://gaz.portic.fr/fieldnames/?format=json
http://127.0.0.1:80/fieldnames/?format=json - http://gaz.portic.fr/fieldnames/?format=json&shortenfields=true
http://127.0.0.1/fieldnames/?format=json&shortenfields=true - http://gaz.portic.fr/fieldnames/?format=json&shortenfields=true&api=ports
http://127.0.0.1/fieldnames/?format=json&shortenfields=true&api=ports - http://gaz.portic.fr/fieldnames/?format=csv&shortenfields=true&api=ports
http://127.0.0.1/fieldnames/?format=csv&shortenfields=true&api=ports
\ No newline at end of file # Liste of Amirautés and Provinces
| amirauté | province |
|-------------------------|------------|
| Dunkerque | Flandre |
| Calais | Picardie |
| Boulogne | Picardie |
| Abbeville | Picardie |
| Saint-Valéry-sur-Somme | Picardie |
| Eu et Tréport | Normandie |
| Dieppe | Normandie |
| Saint-Valéry-en-Caux | Normandie |
| Fécamp | Normandie |
| Havre | Normandie |
| Caudebec et Quilleboeuf | Normandie |
| Rouen | Normandie |
| Honfleur | Normandie |
| Touques | Normandie |
| Dives | Normandie |
| Caen | Normandie |
| Bayeux | Normandie |
| Isigny | Normandie |
| La Hougue | Normandie |
| Barfleur | Normandie |
| Cherbourg | Normandie |
| Port-Bail | Normandie |
| Coutances | Normandie |
| Granville | Normandie |
| Saint-Malo | Bretagne |
| Saint-Brieuc | Bretagne |
| Morlaix | Bretagne |
| Brest | Bretagne |
| Quimper | Bretagne |
| Vannes | Bretagne |
| Nantes | Bretagne |
| Les Sables d'Olonnes | Poitou |
| La Rochelle | Aunis |
| Marennes | Saintonge |
| Bordeaux | Guyenne |
| Bayonne | Guyenne |
| Antibes | Provence |
| Fréjus | Provence |
| Saint-Tropez | Provence |
| Toulon | Provence |
| La Ciotat | Provence |
| Marseille | Provence |
| Martigues | Provence |
| Arles | Provence |
| Aigues-Mortes | Languedoc |
| Sète | Languedoc |
| Agde | Languedoc |
| Narbonne | Languedoc |
| Collioure | Roussillon |
| Bastia | Corse |
| Ajaccio | Corse |
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment