Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<timeseriesparameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseriesparameters.xsd" version="1.23">
    <parameter id="T.obs.mean">
        <name>Observed Monthly Average Temperature</name>
        <parameterType>instantaneous</parameterType>
        <unit>oC</unit>
        <displayUnit>oC</displayUnit>
        <usesDatum>false</usesDatum>
    </parameter>
</timeseriesparameters>

Example PI-JSON response

Code Block
{
  "version" : "1.23",
  "timeSeriesParameters" : [ {
    "id" : "T.obs.mean",
    "name" : "Observed Monthly Average Temperature",
    "parameterType" : "instantaneous",
    "unit" : "oC",
    "displayUnit" : "oC",
    "usesDatum" : "false"
  } ]
}

GET timeseries

Returns a pi timeseries xml file containing the timeseries data filtered by the query parameters.

...

Code Block
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/timeseries?filterId=Netherlands&moduleInstanceIds=ImportObserved&startTime=2013-01-01T00:00:00Z&endTime=2014-01-01T00:00:00Z&convertDatum=false&useDisplayUnits=false&showThresholds=true&omitMissing=true&onlyHeaders=false&showEnsembleMemberIds=false&documentVersion=1.23&forecastCount=1"

Example

...

PI-XML response

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<TimeSeries xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd" version="1.23" xmlns:fs="http://www.wldelft.nl/fews/fs">
    <timeZone>0.0</timeZone>
    <series>
        <header>
            <type>instantaneous</type>
            <moduleInstanceId>ImportObserved</moduleInstanceId>
            <locationId>63306260000</locationId>
            <parameterId>T.obs.mean</parameterId>
            <timeStep unit="nonequidistant"/>
            <startDate date="2013-01-01" time="00:00:00"/>
            <endDate date="2014-01-01" time="00:00:00"/>
            <missVal>-999.0</missVal>
            <stationName>DE BILT</stationName>
            <lat>52.1</lat>
            <lon>5.18</lon>
            <x>5.18</x>
            <y>52.1</y>
            <z>15.0</z>
            <units>oC</units>
        </header>
        <event date="2013-01-01" time="00:00:00" value="2" flag="0"/>
        <event date="2013-02-01" time="00:00:00" value="1.7" flag="0"/>
        <event date="2013-03-01" time="00:00:00" value="2.5" flag="0"/>
        <event date="2013-04-01" time="00:00:00" value="8.1" flag="0"/>
        <event date="2013-05-01" time="00:00:00" value="11.5" flag="0"/>
        <event date="2013-06-01" time="00:00:00" value="15.3" flag="0"/>
        <event date="2013-07-01" time="00:00:00" value="19.2" flag="0"/>
        <event date="2013-08-01" time="00:00:00" value="18.1" flag="0"/>
        <event date="2013-09-01" time="00:00:00" value="14.4" flag="0"/>
        <event date="2013-10-01" time="00:00:00" value="12.2" flag="0"/>
        <event date="2013-11-01" time="00:00:00" value="6.7" flag="0"/>
        <event date="2013-12-01" time="00:00:00" value="5.9" flag="0"/>
        <event date="2014-01-01" time="00:00:00" value="5.7" flag="0"/>
    </series>
    <series>
        <header>
            <type>instantaneous</type>
            <moduleInstanceId>ImportObserved</moduleInstanceId>
            <locationId>63306380000</locationId>
            <parameterId>T.obs.mean</parameterId>
            <timeStep unit="nonequidistant"/>
            <startDate date="2013-01-01" time="00:00:00"/>
            <endDate date="2014-01-01" time="00:00:00"/>
            <missVal>-999.0</missVal>
            <stationName>MAASTRICHT AP</stationName>
            <lat>50.92</lat>
            <lon>5.78</lon>
            <x>5.78</x>
            <y>50.92</y>
            <z>116.0</z>
            <units>oC</units>
        </header>
        <event date="2013-01-01" time="00:00:00" value="1.8" flag="0"/>
        <event date="2013-02-01" time="00:00:00" value="0.8" flag="0"/>
        <event date="2013-03-01" time="00:00:00" value="2.4" flag="0"/>
        <event date="2013-04-01" time="00:00:00" value="9" flag="0"/>
        <event date="2013-05-01" time="00:00:00" value="11.5" flag="0"/>
        <event date="2013-06-01" time="00:00:00" value="15.7" flag="0"/>
        <event date="2013-07-01" time="00:00:00" value="20" flag="0"/>
        <event date="2013-08-01" time="00:00:00" value="18.5" flag="0"/>
        <event date="2013-09-01" time="00:00:00" value="14.4" flag="0"/>
        <event date="2013-10-01" time="00:00:00" value="12.5" flag="0"/>
        <event date="2013-11-01" time="00:00:00" value="5.8" flag="0"/>
        <event date="2013-12-01" time="00:00:00" value="5.6" flag="0"/>
        <event date="2014-01-01" time="00:00:00" value="5.7" flag="0"/>
    </series>
</TimeSeries>        

Example

...

PI-JSON response

Code Block
languagejs
{
  "version" : "1.23",
  "timeZone" : "0.0",
  "timeSeries" : [ {
    "header" : {
      "type" : "instantaneous",
      "moduleInstanceId" : "ImportObserved",
      "locationId" : "63306260000",
      "parameterId" : "T.obs.mean",
      "timeStep" : {
        "unit" : "nonequidistant"
      },
      "startDate" : {
        "date" : "2013-01-01",
        "time" : "00:00:00"
      },
      "endDate" : {
        "date" : "2014-01-01",
        "time" : "00:00:00"
      },
      "missVal" : "-999.0",
      "stationName" : "DE BILT",
      "lat" : "52.1",
      "lon" : "5.18",
      "x" : "5.18",
      "y" : "52.1",
      "z" : "15.0",
      "units" : "oC"
    },
    "events" : [ {
      "date" : "2013-01-01",
      "time" : "00:00:00",
      "value" : "2",
      "flag" : "0"
    }, {
      "date" : "2013-02-01",
      "time" : "00:00:00",
      "value" : "1.7",
      "flag" : "0"
    }, {
      "date" : "2013-03-01",
      "time" : "00:00:00",
      "value" : "2.5",
      "flag" : "0"
    }, {
      "date" : "2013-04-01",
      "time" : "00:00:00",
      "value" : "8.1",
      "flag" : "0"
    }, {
      "date" : "2013-05-01",
      "time" : "00:00:00",
      "value" : "11.5",
      "flag" : "0"
    }, {
      "date" : "2013-06-01",
      "time" : "00:00:00",
      "value" : "15.3",
      "flag" : "0"
    }, {
      "date" : "2013-07-01",
      "time" : "00:00:00",
      "value" : "19.2",
      "flag" : "0"
    }, {
      "date" : "2013-08-01",
      "time" : "00:00:00",
      "value" : "18.1",
      "flag" : "0"
    }, {
      "date" : "2013-09-01",
      "time" : "00:00:00",
      "value" : "14.4",
      "flag" : "0"
    }, {
      "date" : "2013-10-01",
      "time" : "00:00:00",
      "value" : "12.2",
      "flag" : "0"
    }, {
      "date" : "2013-11-01",
      "time" : "00:00:00",
      "value" : "6.7",
      "flag" : "0"
    }, {
      "date" : "2013-12-01",
      "time" : "00:00:00",
      "value" : "5.9",
      "flag" : "0"
    }, {
      "date" : "2014-01-01",
      "time" : "00:00:00",
      "value" : "5.7",
      "flag" : "0"
    } ]
  }, {
    "header" : {
      "type" : "instantaneous",
      "moduleInstanceId" : "ImportObserved",
      "locationId" : "63306380000",
      "parameterId" : "T.obs.mean",
      "timeStep" : {
        "unit" : "nonequidistant"
      },
      "startDate" : {
        "date" : "2013-01-01",
        "time" : "00:00:00"
      },
      "endDate" : {
        "date" : "2014-01-01",
        "time" : "00:00:00"
      },
      "missVal" : "-999.0",
      "stationName" : "MAASTRICHT AP",
      "lat" : "50.92",
      "lon" : "5.78",
      "x" : "5.78",
      "y" : "50.92",
      "z" : "116.0",
      "units" : "oC"
    },
    "events" : [ {
      "date" : "2013-01-01",
      "time" : "00:00:00",
      "value" : "1.8",
      "flag" : "0"
    }, {
      "date" : "2013-02-01",
      "time" : "00:00:00",
      "value" : "0.8",
      "flag" : "0"
    }, {
      "date" : "2013-03-01",
      "time" : "00:00:00",
      "value" : "2.4",
      "flag" : "0"
    }, {
      "date" : "2013-04-01",
      "time" : "00:00:00",
      "value" : "9",
      "flag" : "0"
    }, {
      "date" : "2013-05-01",
      "time" : "00:00:00",
      "value" : "11.5",
      "flag" : "0"
    }, {
      "date" : "2013-06-01",
      "time" : "00:00:00",
      "value" : "15.7",
      "flag" : "0"
    }, {
      "date" : "2013-07-01",
      "time" : "00:00:00",
      "value" : "20",
      "flag" : "0"
    }, {
      "date" : "2013-08-01",
      "time" : "00:00:00",
      "value" : "18.5",
      "flag" : "0"
    }, {
      "date" : "2013-09-01",
      "time" : "00:00:00",
      "value" : "14.4",
      "flag" : "0"
    }, {
      "date" : "2013-10-01",
      "time" : "00:00:00",
      "value" : "12.5",
      "flag" : "0"
    }, {
      "date" : "2013-11-01",
      "time" : "00:00:00",
      "value" : "5.8",
      "flag" : "0"
    }, {
      "date" : "2013-12-01",
      "time" : "00:00:00",
      "value" : "5.6",
      "flag" : "0"
    }, {
      "date" : "2014-01-01",
      "time" : "00:00:00",
      "value" : "5.7",
      "flag" : "0"
    } ]
  } ]
}

...