iwls_api_request.api.endpoint package

Submodules

iwls_api_request.api.endpoint.endpoint_abc module

class iwls_api_request.api.endpoint.endpoint_abc.Endpoint(API, TYPE, BENCHMARK, BENCHMARKS, BENCHMARK_METADATA, ELEVVATIONS, HEIGHT_TYPE, HEIGHT_TYPES, PHENOMENA, PHENOMENON, STATION, STATIONS, STATION_DATA, STATION_METADATA, TIDE_TABLE, TIDE_TABLES, TIME_SERIES_DEFINITION, TIME_SERIE_DEFINITION, GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST=None, STATION_TIME_SERIES=None, STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: ABC

Classe abstraite pour les points d’entrés de l’API.

Parameters:

• API (str) – URL de l’API.

• TYPE (EndpointType) – Type de l’API.

• BENCHMARK (str) – Point d’entrée pour un repère.

• BENCHMARKS (str) – Point d’entrée pour les repères.

• BENCHMARK_METADATA (str) – Point d’entrée pour les métadonnées d’un repère.

• ELEVVATIONS (str) – Point d’entrée pour les élévations d’un repère.

• HEIGHT_TYPE (str) – Point d’entrée pour un type de hauteur.

• HEIGHT_TYPES (str) – Point d’entrée pour les types de hauteurs.

• PHENOMENA (str) – Point d’entrée pour les phénomènes.

• PHENOMENON (str) – Point d’entrée pour un phénomène.

• STATION (str) – Point d’entrée pour une station.

• STATIONS (str) – Point d’entrée pour les stations.

• STATION_DATA (str) – Point d’entrée pour les données d’une station.

• STATION_METADATA (str) – Point d’entrée pour les métadonnées d’une station.

• TIDE_TABLE (str) – Point d’entrée pour une table des marées.

• TIDE_TABLES (str) – Point d’entrée pour les tables des marées.

• TIME_SERIES_DEFINITION (str) – Point d’entrée pour les définitions de séries temporelles.

• TIME_SERIE_DEFINITION (str) – Point d’entrée pour une définition de série temporelle.

• GNSS_STATION (Optional[str]) – Point d’entrée pour une station GNSS.

• GNSS_STATIONS (Optional[str]) – Point d’entrée pour les stations GNSS.

• GNSS_SUM (Optional[str]) – Point d’entrée pour le sommaire des données GNSS.

• REGIONS (Optional[str]) – Point d’entrée pour les régions.

• STATION_DATA_LATEST (Optional[str]) – Point d’entrée pour les dernières données d’une station.

• STATION_TIME_SERIES (Optional[str]) – Point d’entrée pour les séries temporelles d’une station.

• STATION_STATS_DAILY (Optional[str]) – Point d’entrée pour les statistiques journalières d’une station.

• STATION_STATS_MONTHLY (Optional[str]) – Point d’entrée pour les statistiques mensuelles d’une station.

API: str

BENCHMARK: str

BENCHMARKS: str

BENCHMARK_METADATA: str

ELEVVATIONS: str

GNSS_STATION: str | None

GNSS_STATIONS: str | None

GNSS_SUM: str | None

HEIGHT_TYPE: str

HEIGHT_TYPES: str

PHENOMENA: str

PHENOMENON: str

REGIONS: str | None

STATION: str

STATIONS: str

STATION_DATA: str

STATION_DATA_LATEST: str | None

STATION_METADATA: str

STATION_STATS_DAILY: str | None

STATION_STATS_MONTHLY: str | None

STATION_TIME_SERIES: str | None

TIDE_TABLE: str

TIDE_TABLES: str

TIME_SERIES_DEFINITION: str

TIME_SERIE_DEFINITION: str

TYPE: EndpointType

iwls_api_request.api.endpoint.endpoint_private module

class iwls_api_request.api.endpoint.endpoint_private.EndpointPrivate(API, TYPE, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: Endpoint, ABC

class iwls_api_request.api.endpoint.endpoint_private.EndpointPrivateDev(API='', TYPE=EndpointType.PRIVATE_DEV, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de développement.

class iwls_api_request.api.endpoint.endpoint_private.EndpointPrivateProd(API='', TYPE=EndpointType.PRIVATE_PROD, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de production.

iwls_api_request.api.endpoint.endpoint_public module

class iwls_api_request.api.endpoint.endpoint_public.EndpointPublic(API='https://api-iwls.dfo-mpo.gc.ca/api/v1/', TYPE=EndpointType.PUBLIC, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='height-types/{heightTypeId}', HEIGHT_TYPES='height-types', PHENOMENA='phenomena', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations', STATION_DATA='stations/{stationId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tide-tables/{tideTableId}', TIDE_TABLES='tide-tables', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{timeSeriesDefinitionId}', GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST='stations/data/latest', STATION_TIME_SERIES=None, STATION_STATS_DAILY='stations/{stationId}/stats/calculate-daily-means', STATION_STATS_MONTHLY='stations/{stationId}/stats/calculate-monthly-mean')

Bases: Endpoint

Classe pour les points d’entrés de l’API publique.

Module contents

class iwls_api_request.api.endpoint.Endpoint(API, TYPE, BENCHMARK, BENCHMARKS, BENCHMARK_METADATA, ELEVVATIONS, HEIGHT_TYPE, HEIGHT_TYPES, PHENOMENA, PHENOMENON, STATION, STATIONS, STATION_DATA, STATION_METADATA, TIDE_TABLE, TIDE_TABLES, TIME_SERIES_DEFINITION, TIME_SERIE_DEFINITION, GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST=None, STATION_TIME_SERIES=None, STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: ABC

Classe abstraite pour les points d’entrés de l’API.

Parameters:

• API (str) – URL de l’API.

• TYPE (EndpointType) – Type de l’API.

• BENCHMARK (str) – Point d’entrée pour un repère.

• BENCHMARKS (str) – Point d’entrée pour les repères.

• BENCHMARK_METADATA (str) – Point d’entrée pour les métadonnées d’un repère.

• ELEVVATIONS (str) – Point d’entrée pour les élévations d’un repère.

• HEIGHT_TYPE (str) – Point d’entrée pour un type de hauteur.

• HEIGHT_TYPES (str) – Point d’entrée pour les types de hauteurs.

• PHENOMENA (str) – Point d’entrée pour les phénomènes.

• PHENOMENON (str) – Point d’entrée pour un phénomène.

• STATION (str) – Point d’entrée pour une station.

• STATIONS (str) – Point d’entrée pour les stations.

• STATION_DATA (str) – Point d’entrée pour les données d’une station.

• STATION_METADATA (str) – Point d’entrée pour les métadonnées d’une station.

• TIDE_TABLE (str) – Point d’entrée pour une table des marées.

• TIDE_TABLES (str) – Point d’entrée pour les tables des marées.

• TIME_SERIES_DEFINITION (str) – Point d’entrée pour les définitions de séries temporelles.

• TIME_SERIE_DEFINITION (str) – Point d’entrée pour une définition de série temporelle.

• GNSS_STATION (Optional[str]) – Point d’entrée pour une station GNSS.

• GNSS_STATIONS (Optional[str]) – Point d’entrée pour les stations GNSS.

• GNSS_SUM (Optional[str]) – Point d’entrée pour le sommaire des données GNSS.

• REGIONS (Optional[str]) – Point d’entrée pour les régions.

• STATION_DATA_LATEST (Optional[str]) – Point d’entrée pour les dernières données d’une station.

• STATION_TIME_SERIES (Optional[str]) – Point d’entrée pour les séries temporelles d’une station.

• STATION_STATS_DAILY (Optional[str]) – Point d’entrée pour les statistiques journalières d’une station.

• STATION_STATS_MONTHLY (Optional[str]) – Point d’entrée pour les statistiques mensuelles d’une station.

API: str

BENCHMARK: str

BENCHMARKS: str

BENCHMARK_METADATA: str

ELEVVATIONS: str

GNSS_STATION: str | None

GNSS_STATIONS: str | None

GNSS_SUM: str | None

HEIGHT_TYPE: str

HEIGHT_TYPES: str

PHENOMENA: str

PHENOMENON: str

REGIONS: str | None

STATION: str

STATIONS: str

STATION_DATA: str

STATION_DATA_LATEST: str | None

STATION_METADATA: str

STATION_STATS_DAILY: str | None

STATION_STATS_MONTHLY: str | None

STATION_TIME_SERIES: str | None

TIDE_TABLE: str

TIDE_TABLES: str

TIME_SERIES_DEFINITION: str

TIME_SERIE_DEFINITION: str

TYPE: EndpointType

class iwls_api_request.api.endpoint.EndpointPrivateDev(API='', TYPE=EndpointType.PRIVATE_DEV, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de développement.

class iwls_api_request.api.endpoint.EndpointPrivateProd(API='', TYPE=EndpointType.PRIVATE_PROD, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)

Bases: EndpointPrivate

Classe pour les points d’entrés de l’API privée de production.

class iwls_api_request.api.endpoint.EndpointPublic(API='https://api-iwls.dfo-mpo.gc.ca/api/v1/', TYPE=EndpointType.PUBLIC, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='height-types/{heightTypeId}', HEIGHT_TYPES='height-types', PHENOMENA='phenomena', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations', STATION_DATA='stations/{stationId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tide-tables/{tideTableId}', TIDE_TABLES='tide-tables', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{timeSeriesDefinitionId}', GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST='stations/data/latest', STATION_TIME_SERIES=None, STATION_STATS_DAILY='stations/{stationId}/stats/calculate-daily-means', STATION_STATS_MONTHLY='stations/{stationId}/stats/calculate-monthly-mean')

Bases: Endpoint

Classe pour les points d’entrés de l’API publique.

class iwls_api_request.api.endpoint.EndpointType(value)

Bases: StrEnum

classmethod from_str(value)

PRIVATE_DEV = 'EndpointPrivateDev'

PRIVATE_PROD = 'EndpointPrivateProd'

PUBLIC = 'EndpointPublic'