client

README

dp-apipoc-client

A conceptual 'Golang' client implementation targeting the API POC Server.

Configuration

Environment variable	Default	Description
API_SERVER_ROOT	https://api.develop.onsdigital.co.uk	The API host's root URL

Contributing

See CONTRIBUTING for details.

License

Copyright © 2016-2017, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

Documentation

Index

• type ApiClient
  • func NewApiClient() ApiClient

Types

type ApiClient

type ApiClient interface {
	Ping() (int, error)
	Status() (int, model.Status, error)

	GetDatasets(start int, limit int) (int, model.Metadata, error)
	GetDatasetsForId(datasetId string, start int, limit int) (int, model.Metadata, error)
	GetDatasetsForTimeseries(timeseriesId string, start int, limit int) (int, model.Metadata, error)
	GetTimeseries(start int, limit int) (int, model.Metadata, error)
	GetTimeseriesForId(timeseriesId string, start int, limit int) (int, model.Metadata, error)
	GetTimeseriesForDataset(datasetId string, start int, limit int) (int, model.Metadata, error)
	GetDataset(datasetId string, timeseriesId string) (int, model.Record, error)
	Search(term string, start int, limit int) (int, model.Metadata, error)

	GetData(datasetId string, timeseriesId string) (int, model.Data, error)
	// contains filtered or unexported methods
}

func NewApiClient

func NewApiClient() ApiClient