diff src/main/java/de/intevation/lada/rest/stamm/DeskriptorService.java @ 711:3ec358698b4d

Code style and documentation.
author Raimund Renkert <raimund.renkert@intevation.de>
date Wed, 22 Jul 2015 16:03:03 +0200
parents ab539e3f186d
children 5bdd1631a451
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/rest/stamm/DeskriptorService.java	Mon Jul 20 12:19:40 2015 +0200
+++ b/src/main/java/de/intevation/lada/rest/stamm/DeskriptorService.java	Wed Jul 22 16:03:03 2015 +0200
@@ -44,6 +44,13 @@
  *  "success": [boolean];
  *  "message": [string],
  *  "data":[{
+ *      "id": [number],
+ *      "bedeutung": [string],
+ *      "beschreibung": [string],
+ *      "ebene": [number],
+ *      "sn": [number],
+ *      "vorgaenger": [number],
+ *      "sxx": [number]
  *  }],
  *  "errors": [object],
  *  "warnings": [object],
@@ -71,14 +78,15 @@
      * <p>
      * The requested objects can be filtered using the following URL
      * parameters:<br>
-     *  <br>
-     *  The response data contains a stripped set of Probe objects. The returned fields
-     *  are defined in the query used in the request.
+     *  * layer: the layer of the reqested deskriptor<br>
+     *  * parents: the parents of the requested deskriptor<br>
+     * <br>
+     * The response data contains a stripped set of deskriptor objects.
      * <p>
      * Example:
      * http://example.com/deskriptor?layer=[LAYER]
      *
-     * @return Response object containing all Deskriptor objects.
+     * @return Response object containing the Deskriptor objects.
      */
     @GET
     @Path("/")
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)