Message: OtcReport

File: WebAPI/otc_1.proto

Description

OTC/WebAPI responses.

Request: OtcRequest.

Used in

ServerMsg

Fields

request_id

Type: string

Description: ID of a corresponding request or subscription.

status_code

Type: uint32

Description: Operation status. This field is associated with StatusCode enum.

details

Type: shared_1.Text

Description: Operation details.

otc_instances_report

Type: OtcInstancesReport

Description: OTC instances report.

hedge_books_report

Type: HedgeBooksReport

Description: Hedge books report.

hedge_book_details_report

Type: HedgeBookDetailsReport

Description: Hedge book details report.

offset_hedge_balance_result

Type: OffsetHedgeBalanceResult

Description: Offset hedge balance result.

change_otc_state_result

Type: ChangeOtcStateResult

Description: Change OTC state result.

fill_cash_order_result

Type: FillCashOrderResult

Description: Fill cash order result.

archive_hedge_balance_details_result

Type: ArchiveHedgeBalanceDetailsResult

Description: Archive hedge balance details result.

balance_items_links_result

Type: BalanceItemsLinksResult

Description: Balance item links for requested item.

tail_management_configuration_report (deprecated)

Type: TailManagementConfigurationReport

Description: Deprecated. Replaced by tail_management_configuration_report_2.

tail_management_configuration_report_2

Type: TailManagementConfigurationReport2

Description: Tail management configuration report.

tail_management_configuration_metadata

Type: TailManagementConfigurationMetadata

Description: Tail management metadata in ATDL format as string.

update_tail_management_configuration_result

Type: UpdateTailManagementConfigurationResult

Description: Update tail management configuration result.

Enum StatusCode

Values

      STATUS_CODE_SUCCESS = 0

      STATUS_CODE_SUBSCRIBED = 1

     Request is processed and subscription is established.

      STATUS_CODE_DROPPED = 2

     Subscription is dropped by a client request.

      STATUS_CODE_UPDATE = 3

     Unsolicited information update because of subscription.

      STATUS_CODE_DISCONNECTED = 4

     Currently subscription is disconnected because of communication issues.

     Note: Clients should not resubscribe in this case, the server will restore subscription with sending STATUS_CODE_SUBSCRIBED status once communication issues are resolved.

      STATUS_CODE_FAILURE = 101

     General failure.

      STATUS_CODE_INVALID_PARAMS = 102

     Subscription parameters are invalid.

      STATUS_CODE_ACCESS_DENIED = 103

     The user is not allowed to perform the request.

      STATUS_CODE_SUBSCRIPTION_LIMIT_VIOLATION = 104

     The subscription count limit has been violated.

      STATUS_CODE_SUBSCRIPTION_RATE_LIMIT_VIOLATION = 105

     The subscription rate limit has been violated.

      STATUS_CODE_NOT_FOUND = 106

     Object not found.

      STATUS_CODE_TIMEOUT = 107

     Request is timed out.

      STATUS_CODE_DUPLICATE = 108

     Request with same request_id already in use.