...
heartbeat ( int preferredTimeoutSeconds ) |
Detailed documentation
Heartbeat
...
Operations
Heartbeatheartbeat
HeartbeatReport heartbeat ( int preferredTimeoutSeconds ) throws APINGException
...
Throws | Description |
|---|---|
Thrown if the operation fails |
...
Events
This interface does not define any events.
Type definitions
HeartbeatReport
Response from heartbeat operation
Field name | Type | Required | Description |
|---|---|---|---|
actionPerformed |
| The action performed since your last heartbeat request. | |
actualTimeoutSeconds | int |
| The actual timeout applied to your heartbeat request, see timeout request parameter description for details. |
Enums
ActionPerformed
Value | Description |
|---|---|
NONE | No action was performed since last heartbeat, or this is the first heartbeat |
CANCELLATION_REQUEST_SUBMITTED | A request to cancel all unmatched bets was submitted since last heartbeat |
ALL_BETS_CANCELLED | All unmatched bets were cancelled since last heartbeat |
SOME_BETS_NOT_CANCELLED | Not all unmatched bets were cancelled since last heartbeat |
CANCELLATION_REQUEST_ERROR | There was an error requesting cancellation, no bets have been cancelled |
CANCELLATION_STATUS_UNKNOWN | There was no response from requesting cancellation, cancellation status unknown |
Exceptions
APINGException
This exception is thrown when an operation fails
Error code | Description |
|---|---|
INVALID_INPUT_DATA | Invalid input data |
INVALID_SESSION_INFORMATION | The session token passed is invalid |
NO_APP_KEY | An application key is required for this operation |
NO_SESSION | A session token is required for this operation |
INVALID_APP_KEY | The application key passed is invalid |
UNEXPECTED_ERROR | An unexpected internal error occurred that prevented successful request processing. |
Other parameters | Type | Required | Description |
|---|---|---|---|
errorDetails | String |
| Specific error details |
requestUUID | String |
|
|