adjusted api documentation for leaderboard checking/checkout to show all

3 types of requests properly
This commit is contained in:
Kai Börnert committed 2018-04-18 15:02:03 +02:00
1 parent b65f5405ad
commit b757403d97
2 files changed
+72 -4

No files matched your search

@@ -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>
@@ -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>