Gets a status description for the sailing service "RacingEventService". Availability will be reported as "true" if all races to be restored have appeared. There may still be some data retrieval going on, so for the server truly to be available, after having received available:true for the first time, add some leeway that corresponds to the typical race load time.
You can request to obtain available:true only in case all races that are to be restored have finished loading. For this, set the waitUntilRacesLoaded parameter to true.
Furthermore, consider the "replica" attribute in the response. It may start
out as "false" although initial replication has been requested. See also the
/replication/replication?action=STATUS API which provide comprehensive
availability information for a replication set-up. If you can be sure that the
server you're invoking the /status method on is a master, checking for
available:true and waiting for a typical race load time afterwards will be good
enough. In case you're launching a replica, check the /replication/replication?action=STATUS
result for available:true. If you're unsure whether the server you're looking at
is a master or a replica, figure out using /replication/replication?action=STATUS
with the "replica" attribute, and if it is "false" check this endpoint.
Webservice Type: | REST |
Output format: | Json |
Mandatory parameters: | None |
Optional parameters: | waitUntilRacesLoaded: if true, the overall status will be reported as available only if all races that are to be restored have also finished their loading process and moved to state TRACKING, FINISHED, or ERROR. |
Request method: | GET |
Examples: | http://www.sapsailing.com/sailingserver/api/v1/status |
Example Response: |
{ "numberofracestorestore": 48, "numberofracesrestored": 48, "numberofracesrestoreddoneloading": 48, "numberofracesstillloading": 0, "replication": { "replica": false, "replicationstarting": false, "suspended": false, "stopped": false, "messagequeuelength": 0, "operationqueuelengths": [], "totaloperationqueuelength": 0, "replicables": [ { "id": "com.sap.sse.filestorage.impl.FileStorageManagementServiceImpl", "initialloadrunning": false }, { "id": "com.sap.sailing.shared.server.impl.SharedSailingDataImpl", "initialloadrunning": false }, { "id": "com.sap.sse.mail.impl.MailServiceImpl", "initialloadrunning": false }, { "id": "com.sap.sailing.domain.racelogtracking.impl.fixtracker.RegattaLogFixTrackerRegattaListener", "initialloadrunning": false }, { "id": "com.sap.sailing.polars.impl.PolarDataServiceImpl", "initialloadrunning": false }, { "id": "com.sap.sse.security.impl.SecurityServiceImpl", "initialloadrunning": false }, { "id": "com.sap.sailing.windestimation.integration.WindEstimationFactoryServiceImpl", "initialloadrunning": false }, { "id": "com.sap.sailing.server.impl.RacingEventServiceImpl", "initialloadrunning": false } ], "available": true }, "available": true } |