The listRaceDetails operation is provided to allow customers to establish the status of a horse race market both prior to and after the start of the race. This information is available for UK and Ireland races only.
listRaceDetails
Interface | Endpoint | JSON-RPC Prefix | <methodname> Example |
JSON-RPC | <methodname> | ScoresAPING/v1.0/listRaceDetails |
Operation summary
List<RaceDetails> | listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds ) |
Operations
List<RaceDetails> listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds ) throws APINGException
Search for races to get their details.
Parameter name | Type | Required | Description |
---|---|---|---|
meetingIds | Set<MeetingId> |
| Optionally restricts the results to the specified meeting IDs. |
raceIds | Set<RaceId> |
| Optionally restricts the results to the specified race IDs. |
Return type | Description |
---|---|
List<RaceDetails> | List of retrieved race details |
Throws | Description |
---|---|
|
Since 1.0.0
Events
This interface does not define any events.
Type definitions
Race Details
Field name | Type | Required | Description |
---|---|---|---|
meetingId | MeetingId | The unique Id for the meeting equivalent to the eventId for that specific race as returned by listEvents. Optionally restricts the results to the specified meeting IDs. | |
raceId | RaceId | The unique Id for the race in the format meetingid.raceTime (hhmm). Optionally restricts the results to the specified race IDs. | |
raceStatus | RaceStatus | The current status of the race. | |
lastUpdated | LastUpdated |
| This is the time the data was last updated |
responseCode | ResponseCode |
|
Enums
RaceStatus
Value | Description |
---|---|
DORMANT | There is no data available for this race. |
DELAYED | The start of the race has been delayed |
PARADING | The horses are in the parade ring |
GOINGDOWN | The horses are going down to the starting post |
GOINGBEHIND | The horses are going behind the stalls |
ATTHEPOST | The horses are at the post |
UNDERORDERS | The horses are loaded into the stalls/race is about to start |
OFF | The race has started |
FINISHED | The race has finished |
FALSESTART | There has been a false start |
PHOTOGRAPH | The result of the race is subject to a photo finish |
RESULT | The result of the race has been announced |
WEIGHEDIN | The jockeys have weighed in |
RACEVOID | The race has been declared void |
ABANDONED | The meeting has been cancelled |
Value | Description |
---|---|
OK | Data returned successfully |
NO_NEW_UPDATES | No updates since the passes UpdateSequence |
NO_LIVE_DATA_AVAILABLE | Event scores are no longer available or are not on the schedule |
SERVICE_UNAVAILABLE | Data feed for the event type (tennis/football etc) is currently unavailable |
UNEXPECTED_ERROR | An unexpected error occurred retrieving score data |
LIVE_DATA_TEMPORARILY_UNAVAILABLE | Live Data feed for this event/match is temporarily unavailable, data could potentially be |
Exceptions
This exception is thrown when an operation fails
Error code | Description |
---|---|
UNEXPECTED_ERROR | The operation failed with an unexpected error |
INVALID_INPUT_DATA | Invalid input data |
INVALID_SESSION_INFORMATION | The session token passed is invalid or expired |
INVALID_APP_KEY | The application key passed is invalid |
SERVICE_BUSY | The service is currently too busy to service this request |
TIMEOUT_ERROR | Internal call to downstream service timed out |
NO_SESSION | A session token is required for this operation |
NO_APP_KEY | An application key is required for this operation |
TOO_MANY_REQUESTS | Too many requests |
SERVICE_UNAVAILABLE | Service is currently unavailable |
Other parameters | Type | Required | Description |
---|---|---|---|
errorDetails | String |
| The stack trace of the error |
requestUUID | String |
|
|