Gets values on one or more detail parameters for one or more competitors and a time range within the race, with configurable step width. Note that some parameters will work only if the user authenticated has the PREMIUM_LEADERBOARD_INFORMATION permission for the leaderboard queried; this is usually the case when the user has the premium role assigned.
Note furthermore that there is a limit on the number of time points for which values can be obtained by a single request. With PREMIUM_LEADERBOARD_INFORMATION permission for the leaderboard queried, the response can contain values for up to 50,000 time points; otherwise, only up to 1,000 time points can be returned by a single request.
| Webservice Type: | REST |
| Webservice Method: | GET |
| Output format: | Json |
| Mandatory parameters: | competitorId: can occur multiple times and specifies the ID(s) of the competitor(s) for which data is to be obtained leaderboardName: the name of the leaderboard, typically equal to the regattaname path parameter leaderboardGroupNameOrUUID: the UUID or the name of a leaderboard group that contains the leaderboard identified by leaderboardName detailType: can occur multiple times and specifies the type of value(s) to extract for the competitor(s). Possible values are:
|
| Optional parameters: |
fromtime (ISO format, such as 2014-02-14T10:12:03Z) or fromtimeasmillis (time in milliseconds) totime (ISO format, such as 2014-02-14T10:12:03Z) or totimeasmillis (time in milliseconds) stepSizeMillis: the duration, in milliseconds, between the time points for which to compute the values; default is 1000ms (1s) |
| Request method: | GET |
| Example: | http://www.sapsailing.com/sailingserver/api/v1/regattas/ESS%202018%20Barcelona/races/Race%204/competitordata?competitorId=01a01670-c82a-0133-a4ee-448a5b8481d8&competitorId=9e2f64f0-c829-0133-a4eb-448a5b8481d8&leaderboardGroupNameOrUUID=0dcf3fb5-6807-4fd4-86f8-af1757df514a&leaderboardName=ESS%202018%20Barcelona&detailType=LEG_DISTANCE_TRAVELED&detailType=RACE_RANK&fromtimeasmillis=1528987922924&totimeasmillis=1528987923980 |
| Example Output: |
{
"01a01670-c82a-0133-a4ee-448a5b8481d8": [
{
"timepoint-ms": 1528987922924,
"values": {
"RACE_RANK": 2,
"LEG_DISTANCE_TRAVELED": 4103.418328471692
}
},
{
"timepoint-ms": 1528987923924,
"values": {
"RACE_RANK": 2,
"LEG_DISTANCE_TRAVELED": 4115.210926626299
}
}
],
"9e2f64f0-c829-0133-a4eb-448a5b8481d8": [
{
"timepoint-ms": 1528987922924,
"values": {
"RACE_RANK": 1,
"LEG_DISTANCE_TRAVELED": 4431.141055488247
}
},
{
"timepoint-ms": 1528987923924,
"values": {
"RACE_RANK": 1,
"LEG_DISTANCE_TRAVELED": 4442.579981511684
}
}
]
}
|