From b757403d974fbecb85975e03350ce89540b94f42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20B=C3=B6rnert?= Date: Wed, 18 Apr 2018 15:02:03 +0200 Subject: [PATCH] adjusted api documentation for leaderboard checking/checkout to show all 3 types of requests properly --- .../api/v1/leaderboardCheckinPostDoc.html | 50 +++++++++++++++++-- .../api/v1/leaderboardCheckoutPostDoc.html | 26 +++++++++- 2 files changed, 72 insertions(+), 4 deletions(-) diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckinPostDoc.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckinPostDoc.html index 9a9f96b48a2..379698ec1a4 100644 --- a/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckinPostDoc.html +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckinPostDoc.html @@ -39,8 +39,24 @@ Request method: POST + + Payload: + + 

+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.
+
+ + + - Example: + Example comptitor tracking: POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start 

 {
@@ -50,9 +66,37 @@
     "pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
     "fromMillis" : 1415624564718
 }
-
- + + + + Example boat tracking: + POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start + 

+{
+    "boatId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
+    "deviceType" : "ios",
+    "deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
+    "pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
+    "fromMillis" : 1415624564718
+}
+
+ + + + Example mark tracking: + POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/start + 

+{
+    "markId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
+    "deviceType" : "ios",
+    "deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
+    "pushDeviceId" : "0f744707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bbad78",
+    "fromMillis" : 1415624564718
+}
+
+ +
Back to Web Service Overview diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckoutPostDoc.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckoutPostDoc.html index 1d4c041f45c..c09811db1cc 100644 --- a/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckoutPostDoc.html +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/leaderboardCheckoutPostDoc.html @@ -40,7 +40,7 @@ POST - Example: + Example competitor: POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end 

 {
@@ -51,6 +51,30 @@
+ + Example mark: + POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end + 

+{
+    "markId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
+    "deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
+    "toMillis" : 1415624564719
+}
+
+ + + + Example boat: + POST http://sapsailing.com/api/v1/leaderboards/{name}/device_mappings/end + 

+{
+    "boatId" : "af855a56-9726-4a9c-a77e-da955bd289bg",
+    "deviceUuid" : "af855a56-9726-4a9c-a77e-da955bd289bf",
+    "toMillis" : 1415624564719
+}
+
+ +
Back to Web Service Overview