Commit 23822ff5 authored by Christine Plumejeaud's avatar Christine Plumejeaud
Browse files

commentaire pour le paramètre date

parent d53941e0
...@@ -82,6 +82,7 @@ Liste des paramètres communs à chaque requête et valeur par défaut en gras: ...@@ -82,6 +82,7 @@ Liste des paramètres communs à chaque requête et valeur par défaut en gras:
- format : csv | **json** - format : csv | **json**
- shortenfields : true | **false** - shortenfields : true | **false**
- both_to : true | **false** - both_to : true | **false**
- date : YYYY | **1787**
- zipped : true | **false** - zipped : true | **false**
...@@ -119,6 +120,8 @@ Voir la documentation de l'API pour plus de détails. ...@@ -119,6 +120,8 @@ Voir la documentation de l'API pour plus de détails.
Exemple : Exemple :
<http://data.portic.fr/api/travels/?format=json&params=id,departure,destination&both_to=true> <http://data.portic.fr/api/travels/?format=json&params=id,departure,destination&both_to=true>
**date** : pour filtrer les données sur une année donnée. L'année de la date d'arrivée ou de la date de départ doit commencer par ces 4 digits : 1787 ou 1789 par exemple.
**zipped** : pas encore implémenté **zipped** : pas encore implémenté
### 1.2.2. /fieldnames? ### 1.2.2. /fieldnames?
...@@ -134,9 +137,12 @@ Exemple : ...@@ -134,9 +137,12 @@ Exemple :
- http://data.portic.fr/api/pointcalls/?format=csv - http://data.portic.fr/api/pointcalls/?format=csv
- http://data.portic.fr/api/pointcalls/?format=json - http://data.portic.fr/api/pointcalls/?format=json
Par défaut, pas de filtre sur les dates
### 1.2.4. /travels? ### 1.2.4. /travels?
-- TOUT sans duplicats par défaut en json ou csv -- TOUT sans duplicats par défaut en json ou csv
Par défaut, pas de filtre sur les dates
#### 1.2.4.1. /details/departures?lon=lat=radius= #### 1.2.4.1. /details/departures?lon=lat=radius=
...@@ -148,6 +154,7 @@ Return the travels, at the departure of the points located in a 100 km radius ne ...@@ -148,6 +154,7 @@ Return the travels, at the departure of the points located in a 100 km radius ne
http://localhost/api/details/departures/?lat=45.2333&lon=-1.5&radius=100 http://localhost/api/details/departures/?lat=45.2333&lon=-1.5&radius=100
http://localhost/api/details/departures/?lat=45.2333&lon=toto&radius=100 http://localhost/api/details/departures/?lat=45.2333&lon=toto&radius=100
Par défaut, pas de filtre sur les dates
#### 1.2.4.2. /agg/departures?lon=lat=radius= #### 1.2.4.2. /agg/departures?lon=lat=radius=
...@@ -165,7 +172,7 @@ Exemple ...@@ -165,7 +172,7 @@ Exemple
[{"departure":"Fouras","count":2},{"departure":"Martroux","count":6},{"departure":"Port des Barques","count":1},{"departure":"Rochefort","count":562},{"departure":"Soubise","count":44}] [{"departure":"Fouras","count":2},{"departure":"Martroux","count":6},{"departure":"Port des Barques","count":1},{"departure":"Rochefort","count":562},{"departure":"Soubise","count":44}]
``` ```
Par défaut, pas de filtre sur les dates
#### 1.2.4.3. /agg/destinations?lon=lat=radius= #### 1.2.4.3. /agg/destinations?lon=lat=radius=
...@@ -181,7 +188,7 @@ Les calculs spatiaux sont déportés dans le SGBD Postgres pour bénéficier des ...@@ -181,7 +188,7 @@ Les calculs spatiaux sont déportés dans le SGBD Postgres pour bénéficier des
```JS ```JS
[{"label":"Bayonne","value":1,"id":"Bayonne"},{"label":"Bordeaux","value":27,"id":"Bordeaux"},{"label":"Brest","value":43,"id":"Brest"},{"label":"Cherbourg","value":10,"id":"Cherbourg"},{"label":"Dunkerque","value":1,"id":"Dunkerque"},{"label":"Granville","value":1,"id":"Granville"},{"label":"Isigny","value":1,"id":"Isigny"},{"label":"La Hougue","value":1,"id":"La Hougue"},{"label":"La Rochelle","value":3,"id":"La Rochelle"},{"label":"Marennes","value":4,"id":"Marennes"},{"label":"Morlaix","value":29,"id":"Morlaix"},{"label":"Quimper","value":8,"id":"Quimper"},{"label":"Rouen","value":2,"id":"Rouen"},{"label":"Saint-Brieuc","value":1,"id":"Saint-Brieuc"},{"label":"Saint-Malo","value":12,"id":"Saint-Malo"},{"label":"Vannes","value":11,"id":"Vannes"},{"label":null,"value":1,"id":null}] [{"label":"Bayonne","value":1,"id":"Bayonne"},{"label":"Bordeaux","value":27,"id":"Bordeaux"},{"label":"Brest","value":43,"id":"Brest"},{"label":"Cherbourg","value":10,"id":"Cherbourg"},{"label":"Dunkerque","value":1,"id":"Dunkerque"},{"label":"Granville","value":1,"id":"Granville"},{"label":"Isigny","value":1,"id":"Isigny"},{"label":"La Hougue","value":1,"id":"La Hougue"},{"label":"La Rochelle","value":3,"id":"La Rochelle"},{"label":"Marennes","value":4,"id":"Marennes"},{"label":"Morlaix","value":29,"id":"Morlaix"},{"label":"Quimper","value":8,"id":"Quimper"},{"label":"Rouen","value":2,"id":"Rouen"},{"label":"Saint-Brieuc","value":1,"id":"Saint-Brieuc"},{"label":"Saint-Malo","value":12,"id":"Saint-Malo"},{"label":"Vannes","value":11,"id":"Vannes"},{"label":null,"value":1,"id":null}]
``` ```
Par défaut, pas de filtre sur les dates
### 1.2.5. /flows? ### 1.2.5. /flows?
...@@ -198,6 +205,9 @@ Return the flows as specified in API : a list of travels linked to the specifie ...@@ -198,6 +205,9 @@ Return the flows as specified in API : a list of travels linked to the specifie
- params : **all** | tableau des noms longs des attributs de l'API à renvoyer - params : **all** | tableau des noms longs des attributs de l'API à renvoyer
params=pointcall,pointcall_uhgs_id for instance params=pointcall,pointcall_uhgs_id for instance
- both_to : true | **false** - both_to : true | **false**
- date : **1787** | YYYY
Par défaut, filtrage sur la date à 1787.
Examples : Examples :
- http://data.portic.fr:80/api/flows/?format=csv&both_to=false : VERY LONG, AVOID. Use travels instead - http://data.portic.fr:80/api/flows/?format=csv&both_to=false : VERY LONG, AVOID. Use travels instead
......
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