Skip to content
Snippets Groups Projects
Commit 036fba97 authored by Tor-Einar Skog's avatar Tor-Einar Skog
Browse files

doc: Endpoint documentation for POI service

parent fddb796b
No related branches found
No related tags found
No related merge requests found
...@@ -71,8 +71,8 @@ public class POIService { ...@@ -71,8 +71,8 @@ public class POIService {
/** /**
* Get a list of locations (pois) for a given organization * Get a list of locations (pois) for a given organization
* *
* @param organizationId * @param organizationId Database id for the organization
* @return * @return List of weather stations for the organization
*/ */
@GET @GET
@Path("organization/{organizationId}") @Path("organization/{organizationId}")
...@@ -86,7 +86,7 @@ public class POIService { ...@@ -86,7 +86,7 @@ public class POIService {
/** /**
* *
* @param pointOfInterestId * @param pointOfInterestId Database id of the POI
* @return a particular POI (Point of interest) * @return a particular POI (Point of interest)
*/ */
@GET @GET
...@@ -101,8 +101,8 @@ public class POIService { ...@@ -101,8 +101,8 @@ public class POIService {
/** /**
* Find a POI (Point of interest) by name * Find a POI (Point of interest) by name
* *
* @param poiName * @param poiName The name of the POI, e.g. "My FooBar Location"
* @return * @return a particular POI (Point of interest), or HTTP Status 204 (No content) if not found
*/ */
@GET @GET
@Path("name/{poiName}") @Path("name/{poiName}")
...@@ -117,7 +117,7 @@ public class POIService { ...@@ -117,7 +117,7 @@ public class POIService {
* If used outside of VIPSLogic: Requires a valid UUID to be provided in the * If used outside of VIPSLogic: Requires a valid UUID to be provided in the
* Authorization header * Authorization header
* *
* @return * @return a list of POIs belonging to the user currently logged in
*/ */
@GET @GET
@Path("user") @Path("user")
...@@ -140,14 +140,17 @@ public class POIService { ...@@ -140,14 +140,17 @@ public class POIService {
} }
/** /**
* This service is used by the VIPS Field observation app to sync data stored locally on the smartphone with the
* state of the (potentially non-existent) POI in the VIPSLogic database
* TODO Add request example * TODO Add request example
* @param poiJson * @param poiJson Json representation of the POI(s)
* @return * @return The POI(s) in their merged state, serialized to Json
*/ */
@POST @POST
@Path("syncpoifromapp") @Path("syncpoifromapp")
@Consumes("application/json;charset=UTF-8") @Consumes("application/json;charset=UTF-8")
@Produces("application/json;charset=UTF-8") @Produces("application/json;charset=UTF-8")
@TypeHint(PointOfInterest.class)
public Response syncPOIFromApp( public Response syncPOIFromApp(
String poiJson String poiJson
) { ) {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment