Mercurial > lada > lada-server
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 710:2ae27dde4823 | 711:3ec358698b4d |
|---|---|
| 42 * <code> | 42 * <code> |
| 43 * { | 43 * { |
| 44 * "success": [boolean]; | 44 * "success": [boolean]; |
| 45 * "message": [string], | 45 * "message": [string], |
| 46 * "data":[{ | 46 * "data":[{ |
| 47 * "id": [number], | |
| 48 * "bedeutung": [string], | |
| 49 * "beschreibung": [string], | |
| 50 * "ebene": [number], | |
| 51 * "sn": [number], | |
| 52 * "vorgaenger": [number], | |
| 53 * "sxx": [number] | |
| 47 * }], | 54 * }], |
| 48 * "errors": [object], | 55 * "errors": [object], |
| 49 * "warnings": [object], | 56 * "warnings": [object], |
| 50 * "readonly": [boolean], | 57 * "readonly": [boolean], |
| 51 * "totalCount": [number] | 58 * "totalCount": [number] |
| 69 /** | 76 /** |
| 70 * Get all Deskriptor objects. | 77 * Get all Deskriptor objects. |
| 71 * <p> | 78 * <p> |
| 72 * The requested objects can be filtered using the following URL | 79 * The requested objects can be filtered using the following URL |
| 73 * parameters:<br> | 80 * parameters:<br> |
| 74 * <br> | 81 * * layer: the layer of the reqested deskriptor<br> |
| 75 * The response data contains a stripped set of Probe objects. The returned fields | 82 * * parents: the parents of the requested deskriptor<br> |
| 76 * are defined in the query used in the request. | 83 * <br> |
| 84 * The response data contains a stripped set of deskriptor objects. | |
| 77 * <p> | 85 * <p> |
| 78 * Example: | 86 * Example: |
| 79 * http://example.com/deskriptor?layer=[LAYER] | 87 * http://example.com/deskriptor?layer=[LAYER] |
| 80 * | 88 * |
| 81 * @return Response object containing all Deskriptor objects. | 89 * @return Response object containing the Deskriptor objects. |
| 82 */ | 90 */ |
| 83 @GET | 91 @GET |
| 84 @Path("/") | 92 @Path("/") |
| 85 @Produces("application/json") | 93 @Produces("application/json") |
| 86 public Response get( | 94 public Response get( |