The listRaceDetails operation is provided to allow customers to establish the status of a horse race market.
...
Operation summary
List<RaceDetails> | listRaceDetails ( Set<MeetingId> meetingIds, Set<RaceId> raceIds ) |
...
...
Operations
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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 |
|
EnumsEnums
Anchor | ||||
---|---|---|---|---|
|
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 |
Anchor | ||||
---|---|---|---|---|
|
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
...
Anchor | ||
---|---|---|
|
...
|
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
...
...
Operations
List<Score> listScores ( List<UpdateKey> updateKeys ) throws APINGException
Returns a list of current scores for the given events.
Parameter name | Type | Required | Description |
---|---|---|---|
updateKeys | List<UpdateKey> | The filter to select desired markets. All markets that match the criteria in the filter are selected. |
Return type | Description |
---|---|
List<Score> | List of retrieved scores |
Throws | Description |
---|---|
|
Since 1.0.0
...
List<Incidents> listIncidents ( List<UpdateKey> updateKeys ) throws APINGException
Returns a list of incidents for the given events.
Parameter name | Type | Required | Description |
---|---|---|---|
updateKeys | List<UpdateKey> | The filter to select desired markets. All markets that match the criteria in the filter are selected. |
Return type | Description |
---|---|
List<Incidents> | List of retrieved incidents |
Throws | Description |
---|---|
|
Since 1.0.0
...
List<AvailableEvent> listAvailableEvents ( Set<EventId> eventIds, Set<EventTypeId> eventTypeIds, Set<EventStatus> eventStatus ) throws APINGException
Search for events that have live score data available.
Parameter name | Type | Required | Description |
---|---|---|---|
eventIds | Set<EventId> |
| Optionally restricts the results to the specified event IDs. |
eventTypeIds | Set<EventTypeId> |
| Optionally restricts the results to the specified event type IDs. |
eventStatus | Set<EventStatus> |
| Optionally restricts the results to the specified event status. |
Return type | Description |
---|---|
List<AvailableEvent> | List of retrieved available events |
Throws | Description |
---|---|
|
Since 1.0.0
...
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 of retrieved race details
Throws | Description |
---|---|
|
Since 1.0.0
Events
This interface does not define any events.
Type definitions
Key/Value pairs
Field name | Type | Required | Description |
---|---|---|---|
eventId |
| ||
eventTypeId |
|
| |
eventStatus |
|
| |
responseCode |
| ||
incidents | Map<long,Incident> |
|
Key/Value pairs
Field name | Type | Required | Description |
---|---|---|---|
eventId |
| ||
eventTypeId |
|
| |
eventStatus |
|
| |
responseCode |
| ||
updateContext |
| ||
values | Map<String,String> |
|
|
Available events
Field name | Type | Required | Description |
---|---|---|---|
eventId |
| ||
eventTypeId |
| ||
eventStatus |
|
Race Details
Field name | Type | Required | Description |
---|---|---|---|
meetingId |
| ||
raceId |
| ||
raceStatus |
| ||
lastUpdated |
| This is the time the data was last updated | |
responseCode |
|
Update time
Field name | Type | Required | Description |
---|---|---|---|
eventTime |
| This is the eventTime as at the last updated time, format is event type specific. | |
lastUpdated | This is the time the data was last updated | ||
updateSequence | This is the unique identifier associated to each update of the data | ||
updateType | This is the type of update |
Key/Value pairs
Field name | Type | Required | Description |
---|---|---|---|
eventId |
| ||
lastUpdateSequenceProcessed |
| Last update processed by client. If not provided, then all data will be returned for the |
Alias | Type |
---|---|
UpdateSequence | long |
EventId | String |
EventTypeId | String |
EventTime | String |
UpdateType | String |
LastUpdated | Date |
MeetingId | String |
RaceId | String |
Enums
Value | Description |
---|---|
FINISHED |
|
IN_PROGRESS |
|
PENDING |
|
Value | Description |
---|---|
DORMANT |
|
DELAYED |
|
PARADING |
|
GOINGDOWN |
|
GOINGBEHIND |
|
ATTHEPOST |
|
UNDERORDERS |
|
OFF |
|
FINISHED |
|
FALSESTART |
|
PHOTOGRAPH |
|
RESULT |
|
WEIGHEDIN |
|
RACEVOID |
|
ABANDONED |
|
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
...
|