CHyF Services API REST¶

Aperçu¶

Projection¶

Toutes les coordonnées sont affichés en format latitude/longitude (EPSG:4617).

Nombre maximum d’éléments¶

Pour tous les points de fin de l’API des éléments ci-dessous, l’application renvoie un maximum de 5 000 éléments. Vous pouvez modifier ce réglage si vous le voulez.

Spécification d’API¶

La plus récente spécification Open API V3 est disponible sur le serveur :

https://chyf-web.azurewebsites.net/chyf-web/v3/api-docs.yaml (YAML)

https://chyf-web.azurewebsites.net/chyf-web/v3/api-docs (JSON)

Points de fin d’élément¶

Format¶

Le serveur API de base pour les points de fin CHyF est le suivant : https://chyf-web.azurewebsites.net/chyf-web/

Le seul format pris en charge pour les points de fin d’élément est GeoJSON.

Les attributs d’élément GeoJSON diffèrent selon le type d’élément, mais comprennent un sous-ensemble des attributs suivants :

id - identifiant du système
ef_type - code représentant le type de trajet d’écoulement
ef_type_name - description en anglais de l’attribut ef_type.
ec_type - code représentant le type de bassin récepteur
ec_type_name - description en anglais de l’attribut ec_type.
rank - rang (primaire ou secondaire) associé au trajet d’écoulement
length - longueur du trajet d’écoulement
aoi_id - identifiant de zone d’intérêt CHyF
aoi_name - nom de zone d’intérêt CHyF
ecatchment_id - bassin récepteur contenant le trajet d’écoulement
rivernameid1 - identifiant de nom CHyF primaire
rivername1_en - nom anglais de l’élément
rivername1_fr - nom français de l’élément
rivernameid2 - identifiant de nom CHyF secondaire
rivername2_en - nom anglais de l’élément
rivername2_fr - nom français de l’élément
lakenameid1 - identifiant de nom de lac CHyF primaire
lakename1_en - nom anglais de l’élément
lakename1_fr - nom français de l’élément
lakenameid2 - identifiant de nom CHyF secondaire
lakename2_en - nom anglais de l’élément
lakename2_fr - nom français de l’élément

Trouver un élément unique¶

/chyf-web/features/<uuid>

Renvoie l’élément unique représenté par la valeur uuid. Cet élément peut être un trajet d’écoulement, un bassin récepteur ou un rivage. Veuillez noter que le renvoi de nexus n’est pas pris en charge pour le moment.

Recherche par nom ou type d’élément (un ou plusieurs éléments)¶

/chyf-web/features?name= <string> &max-results= <int> &result-type= [BBOX,ALL,GROUPBYTYPE,GROUPBYNAME] &feature-type= [WATERBODY,FLOWPATH,CATCHMENT] &match-type= [EXACT,CONTAINS]

Renvoie tous les éléments qui correspondent aux paramètres de recherche.

name – OBLIGATOIRE – le nom d’élément recherché. Toutes les recherches sont insensibles à la casse.
max-results – FACULTATIF – le nombre maximal d’éléments à renvoyer. La valeur par défaut est de 5 000.
result-type – FACULTATIF (mais recommandé) – définit la façon dont les résultats sont renvoyés. Valeurs valides : BBOX, ALL, GROUPBYTYPE et GROUPBYNAME. La valeur par défaut est BBOX. Nous vous recommandons de tester la même requête avec différents paramètres result-type afin de déterminer celui qui répond le mieux à vos besoins.
- BBOX – pour chaque nom correspondant, un élément unique est renvoyé avec la géométrie représentant le cadre d’objet de tous les éléments correspondants.
- ALL – pour chaque nom correspondant, chaque ligne de base de données correspondante est renvoyée sous la forme d’un élément avec la géométrie d’origine (chaîne de lignes/polygone).
- GROUPBYTYPE - pour chaque nom correspondant, les lignes de base de données correspondantes sont fusionnées par type de géométrie. Un maximum de deux éléments sera renvoyé par nom : un pour les chaînes de lignes et un pour les polygones.
- GROUPBYNAME - pour chaque nom correspondant, les lignes de base de données correspondantes sont fusionnées en un élément unique. Un élément sera renvoyé par nom, et cet élément contiendra une collection géométrique de chaînes de lignes et de polygones.
match-type - FACULTATIF – le type de correspondance à effectuer. Les valeurs valides sont les suivantes : EXACT et CONTAINS. La valeur par défaut est CONTAINS.
feature-type - FACULTTIF – le type d’élément à rechercher. Les valeurs valides comprennent les suivantes : WATERBODY, FLOWPATH et CATCHMENT. Vous pouvez effectuer plusieurs entrées pour rechercher plusieurs types d’éléments. Si vous n’entrez rien, tous les types d’éléments seront recherchés.

Exemples¶

Renvoie des renseignements sur un élément unique dont l’identifiant est f2e7c275-5425-4d19-9db5-d6916b940799 : https://chyf-web.azurewebsites.net/chyf-web/features/f2e7c275-5425-4d19-9db5-d6916b940799

Renvoie toutes les lignes de base de données pour tout type d’élément correspondant au nom South Berland : https://chyf-web.azurewebsites.net/chyf-web/features?name=South+Berland&result-type=ALL

Renvoie un maximum de cinq lignes de base de données pour tout type d’élément correspondant au nom Berland (insensible à la casse) : https://chyf-web.azurewebsites.net/chyf-web/features?name=Berland&result-type=ALL&max-results=5

Renvoie un maximum de cinq lignes de base de données pour les trajets d’écoulement correspondant au nom Berland (insensible à la casse) : https://chyf-web.azurewebsites.net/chyf-web/features?name=Berland&result-type=ALL&max-results=5&feature-type=FLOWPATH

Exportations de réseau¶

Vous pouvez extraire les jeux de données de réseau CHyF au moyen de l’API graphique. Cette exportation comprend tous les trajets d’écoulement, les nexus et les bassins récepteurs pour la zone demandée avec les renseignements de réseau appropriés inclus dans les éléments.

Format¶

Geopackage est le seul format pris en charge pour les exportations de réseau.

API¶

Les exportations de réseau sont limitées à 500 000 trajets d’écoulement. Vous pouvez spécifier la zone d’intérêt en fournissant un cadre d’objet ou une ou plusieurs zones d’intérêt.

aoi - FACULTATIF – une liste délimitée commune des noms abrégés de zone d’intérêt
bbox - FACULTATIF – l’étendue des éléments à inclure dans l’exportation : ‘minlong,minlat,maxlong,maxlat’

Il faut fournir au moins une valeur aoi ou bbox.

Exemple¶

Renvoie une exportation de graphique pour la zone d’intérêt 02OJ000 : https://chyf-web.azurewebsites.net/chyf-web/graph?aoi=02OJ000

Service de tuiles vectorielles¶

Format¶

Le seul format pris en charge pour les services de tuiles vectorielles est MVT (mapbox vector tile).

Points de fin¶

/chyf-web/tiles/water/{z}/{x}/{y}.{format}

Point de fin pour les éléments d’eau. Cela inclut les cours d’eau simples et les plans d’eau polygonaux. Les éléments de sortie comprennent les attributs suivants :

Nom d’attribut	Description
type	Le type d’élément (flowpath ou waterbody).
feature_type	La classification de l’élément. Consultez les attributs ef_type (pour les trajets d’écoulement) et ec_type (pour les plans d’eau) dans la documentation du modèle de données CHyF pour voir les valeurs valides.
feature_type_name	Le nom du type d’élément (par exemple, Skeleton ou Reach).
subtype	La sous-classification de l’élément. Consultez les attributs ef_sub_type (pour les trajets d’écoulement) et ec_sub_type (pour les plans d’eau) dans la documentation du modèle de données CHyF pour voir les valeurs valides.
subtype_name	Le nom de la sous-classification de l’élément.
size	La taille de l’élément. Pour les éléments linéaires, il s’agit de la longueur, en mètres, tandis que pour les éléments polygonaux, il s’agit de la superficie, en mètres carrés.
rank	Le rang associé à l’élément (primaire/secondaire). Cela ne s’applique qu’aux trajets d’écoulement linéaires. Pour en savoir plus, consultez l’attribut rank dans la documentation du modèle de données CHyF.
strahler_order	L’ordre de Strahler associé à l’élément. Pour les plans d’eau, il s’agit de l’ordre de Strahler maximal de toutes les lignes de squelette associées au plan d’eau. L’ordre de Strahler est seulement calculé pour les trajets d’écoulement primaires reach, infrastructure et skeleton. La valeur sera null pour tous les autres trajets d’écoulements et corps d’eau qui ne contiennent pas l’un de ces éléments.
name_en	Le nom anglais associé à l’élément
name_fr	Le nom français associé à l’élément
is_reservoir	Seulement appliqué aux plans d’eau. Sera vrai si le plan d’eau est classé comme un réservoir, sinon les valeurs seront fausses, nulles ou manquantes.

/chyf-web/tiles/ecatchment/{z}/{x}/{y}.{format}

Contient des bassins récepteurs. Actuellement, aucun bassin récepteur n’est chargé dans la base de données CHyF, et ces tuiles vectorielles seront donc vides. Les éléments de sortie comprennent les attributs suivants :

Nom d’attribut	Description
type	Le type de bassin récepteur (elementary_catchment).
size	La superficie du bassin récepteur, en mètres carrés.

/chyf-web/tiles/nhnworkunit/{z}/{x}/{y}.{format}

Point de fin pour les unités de travail polygonales RHN. Les éléments de sortie comprennent les attributs suivants :

Nom d’attribut	Description
id	L’identifiant d’unité de travail RHN (DATASETNAM).
major_drainage_area	Aires de drainage principales des Relevés hydrologiques du Canada (WSCMDA).
sub_drainage_area	Sous-aires de drainage des Relevés hydrologiques du Canada (WSCSDA).
sub_sub_drainage_area	Sous-sous-aires de drainage des Relevés hydrologiques du Canada (WSCSSDA).