SAP Sailing Analytics Webservices API Version 1.0

URL: /api/v1/boats/{id}


Gets information about a single boat, given it's id

Webservice Type: REST
Output format: Json
Mandatory parameters: boatId
Optional parameters: leaderboardName: The name of a regatta leaderboard to be used for the secret check. The secret check will only succeed if the requested boat is part of the regatta. No secret check will happen, if the leaderboardName is not given.
secret: In case the given secret is equal to the one stored in the regatta defined by the leaderboardName, the current user does not need to be authenticated or have the required read permission.
Request method: GET
Example non existing boat:
Example existing boat (please note that the # of the id MUST be url encoded):
Example answer
     {"idtype":"java.lang.String","id":"9ee75a6e-60c2-4a69-993c-b38f45be29ad#1","name":"Boot 1","sailId":"1","color":"#000000","boatClass":{"name":"J\/70","typicallyStartsUpwind":true}}    
Back to Web Service Overview