eclipse-sailing-analytics/sailing-analytics
1
0 Fork 0
mirror of https://github.com/eclipse-sailing-analytics/sailing-analytics.git synced 2026-10-17 01:31:01 +00:00
Code Activity

add REST API doc for smartphone tracking related endpoints

Browse Source
This commit is contained in:
Fredrik Teschke committed 2015-02-14 08:28:45 +01:00
1 parent b14da41518
commit 4b8b667f57
6 files changed
+281 -2
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/competitorTeamGetDoc.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/competitors/{id}/team</h2>
<b>Description:</b>
<p>Gets the details of a competitor's team</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/team">http://www.sapsailing.com/sailingserver/api/v1/competitors/bba11294-9930-11e0-85be-406186cbf87c/team</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/competitorTeamImagePostDoc.html
+61
View File
@@ -0,0 +1,61 @@
<!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/competitors/{id}/team/image</h2>
<b>Description:</b>
<p>Sets the team image</p>
<br/>
<table>
<tr>
<td>Webservice Type:</td>
<td>REST</td>
</tr>
<tr>
<td>Output format:</td>
<td>JSON</td>
</tr>
<tr>
<td>Mandatory headers:</td>
<td>Content-Type: (image-png|image-jpg)</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>Content-Length</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 (Binary data, not multipart)</td>
</tr>
<tr>
<td>Request example:</td>
<td><pre>curl -H "Content-Type:image/jpeg" --data-binary @{image-path} \
http://sapsailing.com/sailingserver/api/v1/competitors/{competitor-id}/team/image</pre></td>
</tr>
<tr>
<td>Response example:</td>
<td><pre>{
"teamImageUri" : "http://training.sapsailing.com/team_images/9871d3a2c554b27151cacf1422eec048.jpeg"
}</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
+18 -2
View File
@@ -96,6 +96,18 @@ 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="leaderboardCheckinPostDoc.html">/api/v1/leaderboards/{name}/device_mappings/start</a></td>
<td>Tracking App Device Checkin on leaderboard</td>
</tr>
<tr>
<td><a href="leaderboardCheckoutPostDoc.html">/api/v1/leaderboards/{name}/device_mappings/end</a></td>
<td>Tracking App Device Checkout on leaderboard</td>
</tr>
<tr>
<td><a href="leaderboardCompetitorGetDoc.html">/api/v1/leaderboards/{name}/competitors/{id}</a></td>
<td>Gets the details of a competitor in the context 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>
@@ -105,8 +117,12 @@ name to make sure you get to the event you're interested in.
<td>Gets the details of a competitor</td>
</tr>
<tr>
<td><a href="leaderboardCompetitorGetDoc.html">/api/v1/leaderboards/{name}/competitors/{id}</a></td>
<td>Gets the details of a competitor in the context of a leaderboard</td>
<td><a href="competitorTeamGetDoc.html">/api/v1/competitors/{id}/team</a></td>
<td>Gets the details of a competitor's team</td>
</tr>
<tr>
<td><a href="competitorTeamImagePostDoc.html">/api/v1/competitors/{id}/team/image</a></td>
<td>Sets the team image</td>
</tr>
</tbody>
</table>
java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckinPostDoc.html
+56
View File
@@ -0,0 +1,56 @@
<!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/leaderboards/{name}/device_mappings/start</h2>
<b>Description:</b>
<p>Tracking App Device Checkin on leaderboard</p>
<br/>
<table>
<tr>
<td>Webservice Type:</td>
<td>REST</td>
</tr>
<tr>
<td>Output format:</td>
<td>HTTP 200 (no body)</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>Mandatory input:</td>
<td>JSON</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><pre>{
"competitorId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
"deviceType" : "ios",
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
"pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
"fromMillis" : 1415624564718
}</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/leaderboardCheckoutPostDoc.html
+54
View File
@@ -0,0 +1,54 @@
<!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/leaderboards/{name}/device_mappings/end</h2>
<b>Description:</b>
<p>Tracking App Device Checkout on leaderboard</p>
<br/>
<table>
<tr>
<td>Webservice Type:</td>
<td>REST</td>
</tr>
<tr>
<td>Output format:</td>
<td>HTTP 200 (no body)</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>Mandatory input:</td>
<td>JSON</td>
</tr>
<tr>
<td>&nbsp;</td>
<td><pre>{
"competitorId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
"toMillis" : 1415624564719
}</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/leaderboardCompetitorGetDoc.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/leaderboards/{name}/competitors/{competitorId}</h2>
<b>Description:</b>
<p>Gets the leaderboard-specific version 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/leaderboards/{name}/competitors/{id}">http://www.sapsailing.com/sailingserver/api/v1/leaderboards/{name}/competitors/{id}</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
<a href="index.html">Back to Web Service Overview</a>
</body>
</html>