mirror of
https://github.com/eclipse-sailing-analytics/sailing-analytics.git
synced 2026-11-09 20:41:10 +00:00
Merge remote-tracking branch 'origin/master' into bug4514
This commit is contained in:
Frank Mittag committed
commit
d3db54a7e6
4 files changed
+135
-4
No files matched your search
@@ -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/boats</h2>
|
||||
|
||||
<b>Description:</b>
|
||||
<p>Gets information about a single boat, given it's id</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>boatId</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Optional parameters:</td>
|
||||
<td>None</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Request method:</td>
|
||||
<td>GET</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example non existing boat:</td>
|
||||
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/boats/invalidId">https://www.sapsailing.com/sailingserver/api/v1/boats/invalidId</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example existing boat (please note that the # of the id MUST be url encoded):</td>
|
||||
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/boats/9ee75a6e-60c2-4a69-993c-b38f45be29ad%231">https://www.sapsailing.com/sailingserver/api/v1/boats/9ee75a6e-60c2-4a69-993c-b38f45be29ad%231</a></td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td>Example answer</td>
|
||||
<td><pre>
|
||||
<code>{"idtype":"java.lang.String","id":"9ee75a6e-60c2-4a69-993c-b38f45be29ad#1","name":"Boot 1","sailId":"1","color":"#000000","boatClass":{"name":"J\/70","typicallyStartsUpwind":true}} </code>
|
||||
</pre></td>
|
||||
</tr>
|
||||
</table>
|
||||
<div style="height: 1em;"></div>
|
||||
<a href="index.html">Back to Web Service Overview</a>
|
||||
</body>
|
||||
</html>
|
||||
@@ -244,6 +244,11 @@ name to make sure you get to the event you're interested in.
|
||||
<td><a href="raceDetailsGetDoc.html">/api/v1/trackedRaces/raceDetails</a></td>
|
||||
<td>Gets more information about a specified RegattaAndRace identifier</td>
|
||||
</tr>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="boats.html">/api/v1/boats</a></td>
|
||||
<td>Obtains information about a single boat</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div style="height: 1em;"></div>
|
||||
|
||||
+47
-3
@@ -39,8 +39,24 @@
|
||||
<td>Request method:</td>
|
||||
<td>POST</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Payload:</td>
|
||||
<td>
|
||||
<pre><code>
|
||||
either of:
|
||||
*competitorId ID of the competitor to map the device to.
|
||||
*boatId ID of the boat to map the device to.
|
||||
*markId ID of the boat to map the device to.
|
||||
deviceType: Either android or ios. Needed for selecting correct push notification service.
|
||||
deviceUuid: UUID generated by the app on first run. Not an identifier that globally identifies the piece of hardware such UDID under iOS, IMEI, or other.
|
||||
pushDeviceId: On Android the GCM regId, on iOS the APNS push token. This is needed for sending push notifications to the device.
|
||||
fromMillis: Milliseconds timestamp from which to map the device to the competitor.
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Example:</td>
|
||||
<td>Example comptitor tracking:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start</a>
|
||||
<pre><code>
|
||||
{
|
||||
@@ -50,9 +66,37 @@
|
||||
"pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
|
||||
"fromMillis" : 1415624564718
|
||||
}
|
||||
</code></pre>
|
||||
</td>
|
||||
</code></pre>
|
||||
</td>
|
||||
<tr>
|
||||
<td>Example boat tracking:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start</a>
|
||||
<pre><code>
|
||||
{
|
||||
"boatId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
|
||||
"deviceType" : "ios",
|
||||
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
|
||||
"pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
|
||||
"fromMillis" : 1415624564718
|
||||
}
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example mark tracking:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start</a>
|
||||
<pre><code>
|
||||
{
|
||||
"markId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
|
||||
"deviceType" : "ios",
|
||||
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
|
||||
"pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
|
||||
"fromMillis" : 1415624564718
|
||||
}
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<div style="height: 1em;"></div>
|
||||
<a href="index.html">Back to Web Service Overview</a>
|
||||
|
||||
+25
-1
@@ -40,7 +40,7 @@
|
||||
<td>POST</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example:</td>
|
||||
<td>Example competitor:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end</a>
|
||||
<pre><code>
|
||||
{
|
||||
@@ -51,6 +51,30 @@
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example mark:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end</a>
|
||||
<pre><code>
|
||||
{
|
||||
"markId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
|
||||
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
|
||||
"toMillis" : 1415624564719
|
||||
}
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Example boat:</td>
|
||||
<td>POST <a href=http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end>http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end</a>
|
||||
<pre><code>
|
||||
{
|
||||
"boatId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
|
||||
"deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
|
||||
"toMillis" : 1415624564719
|
||||
}
|
||||
</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<div style="height: 1em;"></div>
|
||||
<a href="index.html">Back to Web Service Overview</a>
|
||||
|
||||
Reference in new issue
Block a user