Bug 4960: added documentation for creating or updating a tracked event

via REST API endpoint

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.
         <td><a href="trackedeventsGetDoc.html">/api/v1/trackedevents</a></td>
         <td>Gets all tracked events with the associated device-to-competitor/boat/mark elements for the current user.</td>
     </tr>
+    <tr>
+        <td><a href="trackedeventsPutDoc.html">/api/v1/trackedevents</a></td>
+        <td>Create or update a tracked event for the current user.</td>
+    </tr>
 </tbody>
 </table>
 <div style="height: 1em;"></div>

java/com.sap.sailing.server.gateway/webservices/api/v1/trackedeventsPutDoc.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<link href='../../../../sailing-fontface-1.0.cache.css' media='screen'
+ rel='stylesheet' title='Default stylesheet' type='text/css' />
+<link href='../../../main.css' media='screen' rel='stylesheet'
+ title='Default stylesheet' type='text/css' />
+<link rel='icon' href='../../../../sap.ico' type='image/x-icon'>
+<title>SAP Sailing Analytics Webservices API Version 1.0</title>
+</head>
+<body>
+ <h1>SAP Sailing Analytics Webservices API Version 1.0</h1>
+ <h2>URL: /api/v1/trackedevents/{eventId}/{leaderboardName}</h2>
+
+ <b>Description:</b>
+ <p>Create or update a tracked event for the current user.</p>
+ <br />
+ <table>
+  <tr>
+   <td>Webservice Type:</td>
+   <td>REST</td>
+  </tr>
+  <tr>
+   <td>Output format:</td>
+   <td>Json</td>
+  </tr>
+  <tr>
+   <td>Mandatory parameters:</td>
+   <td>Path Parameter eventId: Identifier of the associated event<br />
+    Path Parameter leaderboardName: Name of the associated leaderboard
+   </td>
+  </tr>
+  <tr>
+   <td>Optional parameters:</td>
+   <td>None</td>
+  </tr>
+  <tr>
+   <td>Request method:</td>
+   <td>PUT</td>
+  </tr>
+  <tr>
+   <td>Example:</td>
+   <td>Request:
+    http://www.sapsailing.com/sailingserver/api/v1/trackedevents/61fe232b-19b8-455f-ac91-23a53a5c557a/TestRegattaLeaderboard<br />
+    <br /> Body (device-to-competitor):<br />
+    {"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}<br />
+   <br /> Body(device-to-boat):<br />
+    {"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}<br />
+   <br /> Body (device-to-mark):<br />
+    {"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}<br />
+    Status 202 <br />
+  </tr>
+ </table>
+ <div style="height: 1em;"></div>
+ <a href="index.html">Back to Web Service Overview</a>
+</body>
+</html>