RGSTestAPICSIRO < HydrologyDWG

You are here: OGC Public Wiki>HydrologyDWG Web>WaterML2Part2>ApplicationProgrammingInterfaceDevelopment>RGSTestAPICSIRO (12 Mar 2014, PeterTaylor)Edit Attach

Prototype API @ CSIRO

I've setup a test API with sample data to allow people to see a running service. Details:

There is an auto-documentation endpoint here: http://waterml2.csiro.au/rgs-api/v1/docs
The base page of the API is here: http://waterml2.csiro.au/rgs-api/v1/. You should be able navigate through the links. This data is for a catchment here in Aus.
Username/password is rgs/test for the API.

Please feel free to send through questions or issues.

API examples -

(Pete's work posted by Paul)

I've put a up a development version of the API that now supports XML/GML encodings as well as JSON. So you can see some examples of the current schema here too. It's a bit in flux, and the collection types are not yet supported, but the main resources are available. You can select the output type from the GET drop down in the HTML views, which link to the URLs using ?format=xml|json in the URL. This allows easier use in the browser (content types in http headers is the most appropriate way but less convenient for testing).

The xlinks in the XML are resolvable back into API resources for the main resources. I've incorporated some WDTF vocabs as well for the observed properties (see gaugings example).

Monitoring point collection

Monitoring point

Conversion group

Conversion group collection

Rating collection

Rating table

Gauging collection (for specific monitoring point)

The process has raised some questions about how best to encode collections and how to support discovery, but these are more related to fitting the information model to the API rather than the actual content. There is the start of collections of conversion groups available in XML: http://waterml2.csiro.au/rgs-api/v1/conversion-group/?format=xml, but I'm still working through it. The collections will support filters that relate directly to the specific queries we agree on in the RGS group ( http://external.opengis.org/twiki_public/HydrologyDWG/RgsApiDesign).

Query-based requests

These URLs show how specific queries may be made through the API. These address specific requirements shown in section 3 - Use cases and requirements.

Retrieve ratings for specific monitoring point: http://waterml2.csiro.au/rgs-api/v1/conversion/?monitoring-point=419009
Retrieve latest rating table for specific monitoring point: http://waterml2.csiro.au/rgs-api/v1/conversion/?monitoring-point=419009&latest
Retrieve gauging for a monitoring point after specific date: http://waterml2.csiro.au/rgs-api/v1/gauging/?monitoring-point=419009&start-date=2009-02-15
Retrieve ID list of all gauging for a monitoring point: http://waterml2.csiro.au/rgs-api/v1/gauging/?monitoring-point=419075&format=xml
Fully expanded list of gauging for a monitoring point: http://waterml2.csiro.au/rgs-api/v1/gauging/?monitoring-point=419075&format=xml&expanded

Open questions

(two from Paul's client implementation)

How to get a list of all the available parameter conversions for a site without requesting each table/conversion?
Need to represent identifiers as well as links

-- PeterTaylor - 10 Dec 2013

Topic revision: r5 - 12 Mar 2014, PeterTaylor

HydrologyDWG

The information you supply is used for OGC purposes only. We will never pass your contact details to any third party without your prior consent.
If you enter content here you are agreeing to the OGC privacy policy.

Copyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding OGC Public Wiki? Send feedback