From 5ac3faff2073c588ec7435190fc7cedcccb3c0b0 Mon Sep 17 00:00:00 2001 From: Steffen Jacobs Date: Wed, 26 Jun 2019 16:24:51 +0200 Subject: [PATCH] Bug 4960: added documentation for creating or updating a tracked event via REST API endpoint --- .../webservices/api/v1/index.html | 4 ++ .../api/v1/trackedeventsPutDoc.html | 58 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 java/com.sap.sailing.server.gateway/webservices/api/v1/trackedeventsPutDoc.html diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/index.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/index.html index 434a7cd85be..1919cc9f643 100644 --- a/java/com.sap.sailing.server.gateway/webservices/api/v1/index.html +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/index.html @@ -344,6 +344,10 @@ name to make sure you get to the event you're interested in. /api/v1/trackedevents Gets all tracked events with the associated device-to-competitor/boat/mark elements for the current user. + + /api/v1/trackedevents + Create or update a tracked event for the current user. +
diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/trackedeventsPutDoc.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/trackedeventsPutDoc.html new file mode 100644 index 00000000000..47ca142ee3e --- /dev/null +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/trackedeventsPutDoc.html @@ -0,0 +1,58 @@ + + + + + + + +SAP Sailing Analytics Webservices API Version 1.0 + + +

SAP Sailing Analytics Webservices API Version 1.0

+

URL: /api/v1/trackedevents/{eventId}/{leaderboardName}

+ + Description: +

Create or update a tracked event for the current user.

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Webservice Type:REST
Output format:Json
Mandatory parameters:Path Parameter eventId: Identifier of the associated event
+ Path Parameter leaderboardName: Name of the associated leaderboard +
Optional parameters:None
Request method:PUT
Example:Request: + http://www.sapsailing.com/sailingserver/api/v1/trackedevents/61fe232b-19b8-455f-ac91-23a53a5c557a/TestRegattaLeaderboard
+
Body (device-to-competitor):
+ {"url":"http://www.sapsailing.com","regattaSecret":"71fe232b-19b8-455f-ac91-23a53a5c557a","trackedElements":[{"deviceId":"301eda00-68ad-402d-9734-4a7d5b8df406","competitorId":"6204e6d2-2d6c-4891-b077-d83117c69513"}],"isArchived":false}
+
Body(device-to-boat):
+ {"url":"http://www.sapsailing.com","regattaSecret":"71fe232b-19b8-455f-ac91-23a53a5c557a","trackedElements":[{"deviceId":"301eda00-68ad-402d-9734-4a7d5b8df406","boatId":"6204e6d2-2d6c-4891-b077-d83117c69513"}],"isArchived":false}
+
Body (device-to-mark):
+ {"url":"http://www.sapsailing.com","regattaSecret":"71fe232b-19b8-455f-ac91-23a53a5c557a","trackedElements":[{"deviceId":"301eda00-68ad-402d-9734-4a7d5b8df406","markId":"6204e6d2-2d6c-4891-b077-d83117c69513"}],"isArchived":false}
+ Status 202
+
+
+ Back to Web Service Overview + +