File

libs/core/src/lib/dataset-api/interfaces/api-v1.interface.ts

Index

Methods

Methods

getCategories
getCategories(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getCategory
getCategory(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getFeature
getFeature(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getFeatures
getFeatures(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getOffering
getOffering(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getOfferings
getOfferings(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getPhenomena
getPhenomena(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getPhenomenon
getPhenomenon(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getProcedure
getProcedure(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getProcedures
getProcedures(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getService
getService(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getServices
getServices(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)

Test

Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes

temp

getSingleTimeseries
getSingleTimeseries(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getSingleTimeseriesByInternalId
getSingleTimeseriesByInternalId(internalId: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
internalId string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getStation
getStation(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
id string No
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getStations
getStations(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getTimeseries
getTimeseries(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
params ParameterFilter Yes
options HttpRequestOptions Yes
getTimeseriesData
getTimeseriesData(apiUrl: string, ids: string[], timespan: Timespan, options?: HttpRequestOptions)
Parameters :
Name Type Optional
apiUrl string No
ids string[] No
timespan Timespan No
options HttpRequestOptions Yes
getTimeseriesExtras
getTimeseriesExtras(id: string, apiUrl: string)
Parameters :
Name Type Optional
id string No
apiUrl string No
getTsData
getTsData(id: string, apiUrl: string, timespan: Timespan, params?: DataParameterFilter, options?: HttpRequestOptions)
Type parameters :
  • T
Parameters :
Name Type Optional
id string No
apiUrl string No
timespan Timespan No
params DataParameterFilter Yes
options HttpRequestOptions Yes
import { Observable } from 'rxjs';

import { Category } from '../../model/dataset-api/category';
import { Data } from '../../model/dataset-api/data';
import { Timeseries, TimeseriesData, TimeseriesExtras } from '../../model/dataset-api/dataset';
import { Feature } from '../../model/dataset-api/feature';
import { Offering } from '../../model/dataset-api/offering';
import { Phenomenon } from '../../model/dataset-api/phenomenon';
import { Procedure } from '../../model/dataset-api/procedure';
import { Service } from '../../model/dataset-api/service';
import { Station } from '../../model/dataset-api/station';
import { DataParameterFilter, HttpRequestOptions, ParameterFilter } from '../../model/internal/http-requests';
import { Timespan } from '../../model/internal/timeInterval';

export interface DatasetApiV1 {

    /**
     * Test
     * @param id
     * @return temp
     */
    getServices(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Service[]>;
    getService(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Service>;

    getStations(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Station[]>;
    getStation(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Station>;

    getTimeseries(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Timeseries[]>;
    getTimeseriesData(apiUrl: string, ids: string[], timespan: Timespan, options?: HttpRequestOptions): Observable<TimeseriesData[]>;
    getSingleTimeseries(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Timeseries>;
    getSingleTimeseriesByInternalId(internalId: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Timeseries>;
    getTimeseriesExtras(id: string, apiUrl: string): Observable<TimeseriesExtras>;

    getTsData<T>(id: string, apiUrl: string, timespan: Timespan, params?: DataParameterFilter, options?: HttpRequestOptions): Observable<Data<T>>;

    getCategories(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Category[]>;
    getCategory(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Category>;

    getPhenomena(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Phenomenon[]>;
    getPhenomenon(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Phenomenon>;

    getOfferings(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Offering[]>;
    getOffering(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Offering>;

    getFeatures(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Feature[]>;
    getFeature(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Feature>;

    getProcedures(apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Procedure[]>;
    getProcedure(id: string, apiUrl: string, params?: ParameterFilter, options?: HttpRequestOptions): Observable<Procedure>;

}

result-matching ""

    No results matching ""