eclipse-sailing-analytics/sailing-analytics
1
0 Fork 0
mirror of https://github.com/eclipse-sailing-analytics/sailing-analytics.git synced 2026-10-04 03:13:49 +00:00
Code Activity

update api documentation

Browse Source
This commit is contained in:
Fredrik Teschke committed 2014-12-11 11:58:21 +01:00
1 parent d88f2e30a9
commit 0929262243
10 files changed
+135 -8
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

java/com.sap.sailing.server.gateway/webservices/api/v1/competitorGetDoc.html
+46
View File
@@ -0,0 +1,46 @@
<!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='../../../../fontface.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 Beta</title>
</head>
<body>
<h1>SAP Sailing Analytics Webservices API Version 1.0 Beta</h1>
<h2>URL: /api/v1/events/{eventId}</h2>
<b>Description:</b>
<p>Gets the details of a competitor</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>None</td>
</tr>
<tr>
<td>Optional parameters:</td>
<td>None</td>
</tr>
<tr>
<td>Request method:</td>
<td>GET</td>
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/competitors/bba11294-9930-11e0-85be-406186cbf87c">http://www.sapsailing.com/sailingserver/api/v1/competitors/bba11294-9930-11e0-85be-406186cbf87c</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
<a href="index.html">Back to Web Service Overview</a>
</body>
</html>
java/com.sap.sailing.server.gateway/webservices/api/v1/gpsFixesPostDoc.html
+73
View File
@@ -0,0 +1,73 @@
<!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='../../../../fontface.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 Beta</title>
</head>
<body>
<h1>SAP Sailing Analytics Webservices API Version 1.0 Beta</h1>
<h2>URL: /api/v1/gps_fixes</h2>
<b>Description:</b>
<p>Adds an arbitrary number GPS-fixes that originated from a device with a unique identifier to the GPSFixStore.
These can be mapped to a competitor or a mark via the DeviceMappings in the RaceLog-Tracking connector.</p>
<br/>
<table>
<tr>
<td>Webservice Type:</td>
<td>REST</td>
</tr>
<tr>
<td>Post data input format:</td>
<td>JSON</td>
</tr>
<tr>
<td>Output format:</td>
<td>HTTP 200</td>
</tr>
<tr>
<td>Mandatory parameters:</td>
<td>None</td>
</tr>
<tr>
<td>Optional parameters:</td>
<td>None</td>
</tr>
<tr>
<td>Request method:</td>
<td>POST</td>
</tr>
<tr>
<td>Example:</td>
<td>
POST the following JSON data to <a href="http://www.sapsailing.com/sailingserver/api/v1/gps_fixes">http://www.sapsailing.com/sailingserver/api/v1/gps_fixes</a>
<pre><code>
{
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
"fixes" : [
{
"timestamp" : 14144160080000,
"latitude" : 54.325246,
"longitude" : 10.148556,
"speed" : 3.61,
"course" : 258.11,
},
{
"timestamp" : 14144168490000,
"latitude" : 55.12456,
"longitude" : 8.03456,
"speed" : 5.1,
"course" : 14.2,
}
]
}
</code></pre></td>
</tr>
</table>
<div style="height: 1em;"></div>
<a href="index.html">Back to Web Service Overview</a>
</body>
</html>
java/com.sap.sailing.server.gateway/webservices/api/v1/index.html
+9 -1
View File
@@ -37,7 +37,7 @@ name to make sure you get to the event you're interested in.
<td>Gets all events</td>
</tr>
<tr>
<td><a href="eventGetDoc.html">/api/v1/events/{name}</a></td>
<td><a href="eventGetDoc.html">/api/v1/events/{id}</a></td>
<td>Gets the details of an event</td>
</tr>
<tr>
@@ -96,6 +96,14 @@ name to make sure you get to the event you're interested in.
<td><a href="leaderboardGetDoc.html">/api/v1/leaderboards/{name}</a></td>
<td>Gets the details of a leaderboard</td>
</tr>
<tr>
<td><a href="gpsFixesPostDoc.html">/api/v1/gps_fixes</a></td>
<td>Adds GPS-fixes that originated from a device with a unique identifier</td>
</tr>
<tr>
<td><a href="competitorGetDoc.html">/api/v1/competitors/{id}</a></td>
<td>Gets the details of a competitor</td>
</tr>
</tbody>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceBearingOfFirstLegGetDoc.html
+1 -1
View File
@@ -40,7 +40,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/Travemunder%20Woche%202013%20(Finn)/races/Finn%20Race%204/firstlegbearing">http://www.sapsailing.com/sailingserver/api/v1/regattas/Travemunder%20Woche%202013%20(Finn)/races/Finn%20Race%204/firstlegbearing</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/firstlegbearing">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/firstlegbearing</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceCompetitorLegsGetDoc.html
+1 -1
View File
@@ -37,7 +37,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/competitors/legs">http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/competitors/legs</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/competitors/legs">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/competitors/legs</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceCompetitorPositionsGetDoc.html
+1 -1
View File
@@ -44,7 +44,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/competitors/positions">http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/competitors/positions</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/competitors/positions">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/competitors/positions</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceCourseGetDoc.html
+1 -1
View File
@@ -37,7 +37,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/course">http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/course</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/course">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/course</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceMarkPassingsGetDoc.html
+1 -1
View File
@@ -39,7 +39,7 @@ the waypoints are ordered by the time at which the competitor passed the mark.</
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/Travemunder%20Woche%202013%20(Finn)/races/Finn%20Race%204/markpassings">http://www.sapsailing.com/sailingserver/api/v1/regattas/Travemunder%20Woche%202013%20(Finn)/races/Finn%20Race%204/markpassings</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/markpassings">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/markpassings</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceMarkPositionsGetDoc.html
+1 -1
View File
@@ -42,7 +42,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/marks/positions">http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/marks/positions</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/marks/positions">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/marks/positions</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
java/com.sap.sailing.server.gateway/webservices/api/v1/raceWindGetDoc.html
+1 -1
View File
@@ -46,7 +46,7 @@
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/wind">http://www.sapsailing.com/sailingserver/api/v1/regattas/{regattaname}/races/{racename}/wind</a></td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/wind">http://www.sapsailing.com/sailingserver/api/v1/regattas/TW%202013%20(Finn)/races/Finn%20Race%204/wind</a></td>
</tr>
</table>
<div style="height: 1em;"></div>