Versions Compared

Key

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

...

Code Block
datum,status,Yes or no,int,double,string
20030222000000,Ok,F,14,1.45,Overview 1 description 2
20030223000000,Not Ok,T,24,2.45,Overview 1 description 2


GET version

GET version inforamtion of the current installed Web Services.

Request parameters

  • documentFormat (string): PI_XML (default) or PI_JSON

Response

    • PI-XML or PI-JSON file content.

Example request

Code Block
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/version"

Example PI-XML response

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<Version 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_version.xsd">
    <implementation>2017.02</implementation>
    <buildType>stable</buildType>
    <buildNumber>12345</buildNumber>
    <buildTime>2017-10-31T23:00:00Z</buildTime>
</Version>

GET oas

GET open api specification of the REST API.

Response

    • JSON response with the open api specification.

Example request

Code Block
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/oas"

Example PI-XML response

Code Block
{
  "openapi" : "3.0.3",
  "info" : {
    "title" : "Delft-FEWS Web Services - Schematic Status Display (SSD) Web Service",
    "description" : "Delft-FEWS Web Services - Schematic Status Display (SSD) Web Service. For more information see: https://publicwiki.deltares.nl/x/OwXkC",
    "version" : ""
  },
  "servers" : [ {
    "url" : "/FewsWebServices",
    "description" : "API server"
  } ]
}