SAP Sailing Analytics Webservices API Version 1.0

URL: /sailingserver/api/v1/livecontent

Description:

Reports the "live content" hosted by this server instance at a given point in time. Content is considered "live" when it is being tracked, i.e. when the point in time to check falls into the tracking interval of a race. The result is grouped hierarchically by replica set, then by event, and finally by the individual tracked races. Only events that may be live at the checked point in time and that actually contain at least one tracked race are included, and events and races are sorted by their names.

This endpoint is primarily used to decide whether a server or replica set may be safely taken down or migrated: if it reports any live content for the current point in time, an operation that would interrupt tracking should be avoided.

All time points in the response are encoded as epoch milliseconds (UTC). A missing (unbounded) time point, such as the end of tracking of a race that is still being tracked or an event without a defined start or end date, is reported as null. Every race that is returned is guaranteed to have a non-null trackingStartMillis; only trackingEndMillis may be null.

Permissions: accessing this endpoint requires the MANAGE permission on the landscape (AWS) object; without it the request is rejected.


Webservice Type: REST
Output format: Json
Mandatory parameters: None
Optional parameters: checkedAtMillis: the point in time to check for live content, given as epoch milliseconds (UTC). If omitted, the server's current time is used.
Request method: GET
Examples: http://www.sapsailing.com/sailingserver/api/v1/livecontent
http://www.sapsailing.com/sailingserver/api/v1/livecontent?checkedAtMillis=1700000000000
Example Response:
			{
			  "checkedAtMillis": 1700000000000,
			  "replicaSets": [
			    {
			      "replicaSetName": "www",
			      "events": [
			        {
			          "eventId": "a1b2c3d4-0000-0000-0000-000000000000",
			          "eventName": "Kiel Week 2023",
			          "eventStartMillis": 1699900000000,
			          "eventEndMillis": 1700400000000,
			          "races": [
			            {
			              "regattaName": "49er",
			              "raceName": "R1",
			              "trackingStartMillis": 1699999000000,
			              "trackingEndMillis": null
			            },
			            {
			              "regattaName": "49er",
			              "raceName": "R2",
			              "trackingStartMillis": 1699995000000,
			              "trackingEndMillis": 1699998000000
			            }
			          ]
			        }
			      ]
			    }
			  ]
			}
        
Back to Web Service Overview