EMAPI Messages/ConstantGroups Revision History 1.6.0 => 1.7.0

Messages

1 General Messages

TaxSnapshotSubscribeReq
ResponseMessage
SimpleRsp
TaxReplayReq
TaxReplayStartEvent
TaxReplayEndEvent
GetSequenceNumbersReq

1.1 General Messages (Internal)

FlowReverseInfo

2 Subscription

2.1 Establishment

2.2 Surveillance Messages

2.3 Termination Messages

3 Reference Data Messages

Currency
Member
Instrument
TradableInstrument
Market
MarketList
Segment
EligibleSecurity
EligibleCurrency
PositionAccount
RiskNode
ClearingMemberLink
TripartiteAgreement
CdUpdateCashAccountReq
User

3.1 External Members

3.2 Clearing House

4 Event Messages

AccountPositionEvent
DailyAccountSummaryDetailsEvent
AggregatedSummaryClearingMemberEvent
AggregatedSummaryTradingMemberEvent
AccountTradeEvent
RiskNodeEvent
CommissionEvent
WithdrawalNotificationEvent

4.1 Event Messages (Internal)

Trade
AggregatedSummaryDetails

4.2 External Members

GiveUpEvent

4.3 Clearing House

5 Trade Management Messages

QueryTradesReq
AllocateTradeReq
AggregateTradesReq
CancelGiveUpReq
ApproveGiveUpReq
RejectGiveUpReq
AddCommissionReq
CancelCommissionReq
RejectCommissionReq

5.1 Trade Management Messages (Internal)

TradeRes
Commission

6 Pricing Messages

7 Risk Messages

7.1 External Members

7.2 Clearing House

8 Settlement Messages

GetPaymentAdvicesReq
GetPaymentAdvicesRsp

8.1 External Members

ReadyConfirmAvailableFXEvent
RegisterFXCollateralReq
RegisterFXCollateralRsp
CmBalancing1Event
CmBalancing2Event
8.1.1 External Members (Internal)
FXCollateral
FXCollateralStatus
MemberBalance2

8.2 Clearing House

9 Position Messages

9.1 External Members

9.2 Clearing House

10 Reference Data

10.1 General Messages

10.1.1 General Management Messages

Constant Groups

CondType
PositionReason
CommissionStatus
SessionStatus
FeedSource

Messages

1 General Messages

Message nameField nameAttribute nameChanged fromChanged to
TaxSnapshotSubscribeReqsequenceNumberDescriptionOnly considered by the Server if the flow contains trade events (i.e. TradeEvent and/or TradeEventPrivate).
  • If this field is set to a negative number the last specified number (i.e. the absolute value of the field) of trade events in each order book (covered by the request) are added to the current value.
  • If this field is set to a non-negative number all trade events (in the order books covered by the request) with a sequence number that is equal to or higher than the value of this field are added to the current value.
N.B. No filtering of the trade events is done (e.g. the trade events may be of all trade types - so for example on private trading flows the trade events may be of the trade type TRADE_REPORT_HALF).
Not used in this configuration of RTC.
lastPollSequenceNumberDescriptionThe sequence number of the last poll operation. Results in an empty snapshot if no changes have been made since last poll for this key/subscription group. Note! This option should only be used if requestType is CURRENT_VALUE.Not used in this configuration of RTC.
ResponseMessageDescriptionThis class adds a TapStatus to a plain message making up a response headerGeneral response for request messages that dont't have a defined response. It may also be used when a fatal error occurs before or during the normal response handling on the server.
SimpleRspDescriptionSimple response, for instance an order or auction idGeneral response for request messages that dont't have a defined response.
TaxReplayReqDescriptionRequest message sent to the trading system to recover a sequence of messages published earlier. The replay request will recover earlier published messages on a replayable flow. The response back is a simple response indicating whatever the request was successfully queued to the trading system. The actual replay data is delivered as unsolicited events, framed by TaxReplayStartEvent and TaxReplayEndEvent messages.Request message sent to the RTC system to recover a sequence of messages published earlier. The replay request will recover earlier published messages on a replayable flow. The response back is a simple response indicating whatever the request was successfully queued to the RTC system. The actual replay data is delivered as unsolicited events, framed by TaxReplayStartEvent and TaxReplayEndEvent messages.
subscriptionGroupDescriptionThe subscription group to which the order books of interest belong.The subscription group on the subscribed flow.
TaxReplayStartEventsubscriptionGroupDescriptionThe subscription group the data is for. The identifier is always set to zero for global flows.The subscription group the data is for.
TaxReplayEndEventinternalCodeDescriptionInternal status code from the trading system.Not used in this configuration of RTC.
GetSequenceNumbersReqbroadcastFlowIdmandatoryrequired
subscriptionGroupIdmandatoryrequired

1.1 General Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
FlowReverseInfoDescriptionSub-structure defining sequence and timestamp for a system 'reverse'. Events with a sequence number higher than the 'reverted-to' sequence and a time-of-event less than the 'after-reverse' timestamp have been reverted by the system.Not used in this configuration of RTC.

2 Subscription

2.1 Establishment

2.2 Surveillance Messages

2.3 Termination Messages

3 Reference Data Messages

Message nameField nameAttribute nameChanged fromChanged to
CurrencycurrencyCodeDescriptionISO Currency Code, for example 710 for ZAR.ISO Currency Numeric Code, for example 710 for ZAR.
MembermemberIdDescriptionThe public id of the member. This id has to be unique. When/if a member change memberId, the assigned memberInternalId must be the same in order to be able to track old orders/trades.The public ID of the participant. This id has to be unique.
addressDescriptionCompany snail-mail addressCompany postal address.
faxDescriptionCompany Fax number.Company fax address.
isDisabledDescriptionSet to true if this member has been disabled. Disabling a member will automatically disable all the users belonging to the member. Disabling a member also means that all active orders will be inactivated for the member.Set to true if this member has been disabled.
InstrumentisEnabledDescriptionThe administrative state of this item. If is enabled is set to false, all orderbooks at this and all levels below will be set to a persistent full-halt state.The state of this item.
disabledCountDescriptionA count of how many times this element has been enabled/disabled. An element will not be enabled until disabledCount is zero.Not used in this configuration of RTC.
prevInstrumentIdDescriptionThe previous (if any) instrument id. Used in case of corporate action etc where an instrument may change instrument code.Not used in this configuration of RTC.
prevInstrumentIdTypeDescriptionThe type of the prevInstrumentId (ISIN, CUSIP etc)Not used in this configuration of RTC.
adtDescriptionThe Average Daily Turnover for the instrument. This field is actually required for an Instrument, but unfortunately it cannot be automatically validated.Not used in this configuration of RTC.
adtCurrencyDescriptionThe ADT currency code (ISO 4217) for the currency expressed. This field is actually required for an Instrument, but unfortunately it cannot be automatically validated.Not used in this configuration of RTC.
TradableInstrumentisEnabledDescriptionThe administrative state of this item. If is enabled is set to false, all orderbooks at this and all levels below will be set to a persistent full-halt state.The state of this item.
shortNameDescriptionDisplay name of this tradable instrument, ERICB for exampleDisplay name of this tradable instrument.
settlementCycleDescriptionSettlement cycle in daysSettlement cycle in days. Mandatory for instrument type Spot.
contractDescriptionDescriptionThe Contract Description. Example: AGLSThe Contract Description.
liquidationPeriodDescriptionThe liquidation period used in the IMR calculation. Also used for the calculation of the Liquidity Add-on. For example, 1 for daily and 7 for weekly. Used for spot instruments.The liquidation period used in the IMR calculation. Also used for the calculation of the Liquidity Add-on. For example, 1 for daily and 7 for weekly. Mandatory for spot instruments.
advtDescriptionThe Average Daily Value Traded, used for the calculation of the Liquidity Add-on. Used for spot instruments.The Average Daily Value Traded, used for the calculation of the Liquidity Add-on. Mandatory for spot instruments.
maturityDateDescriptionMaturity Date for Bonds.Maturity Date for Bonds. Format yyyy-mm-dd.
anydayDescriptionIf Anyday is true, the expiry date if the instrument may be on any business day.If Anyday is true, the expiry date of the instrument may be on any business day.
MarketDescriptionDefines a market. The interpretation of what a market represent is customer specific. Some operations on a market, such as halt, enable and disable, will affect all child objects (MarketLists, Segments and all related TradableInstruments) within the market.Defines a market.
isEnabledDescriptionThe administrative state of this item. If it is set to false, all orderbooks at this and all levels below will be set to a persistent full-halt state.The state of this item.
lookbackPerioddivisorQTY
volatilityLookbackPerioddivisorQTY
imrStatisticsPerioddivisorQTY
DescriptionNumber of days to compare price and volatility move for in the IMR GUI and IMR reports.Number of days to compare price and volatility move for.
nonTradingDaysBeforeDefaultdivisorQTY
validFromDateDescriptionThe first date the ,arket is valid. The format is yyyy-MM-dd.The first date the market is valid. The format is yyyy-MM-dd.
MarketListinternalMarketListIdDescriptionThe internal (unique) id of the MarketList. It is assumed that the internalMarketListId is null for a new MarketList.The internal (unique) id of the MarketList. Set by RTC.
isEnabledDescriptionThe administrative state of this item. If is enabled is set to false, all orderbooks at this and all levels below will be set to a persistent full-halt state.The state of this item.
SegmentisEnabledDescriptionThe administrative state of this item. If is enabled is set to false, all orderbooks at this and all levels below will be set to a persistent full-halt state.The state of this item.
parentInternalIdDescriptionThe parent MarketList id (EMAPI).The parent Market List ID.
EligibleSecurityDescriptionEligible Secutiry.Security instrument eligible for collateral.
updateTimestampHas been removed.
EligibleCurrencyDescriptionEligible Currency.Currency eligible for FX collateral.
updateTimestampHas been removed.
PositionAccountDescriptionThis object defines a position account.Position account is used to keep actual clearing positions and settlement positions.
isEnabledDescriptionThe risk group for the Position Account.The state of this item.
RiskNodeDescriptionThis object defines a risk node.Risk node is the entity that defines the level for risk calculations. It has one or several accounts connected and form a tree structure with aggregated risk numbers on parent nodes.
channelsHas been removed.
ClearingMemberLinkeffectiveDateDescriptionThe effective date from which the link shall be used for capture of incoming trades.The effective date from which the link shall be used for capture of incoming trades. The format is yyyy-mm-dd.
TripartiteAgreementfromDateDescriptionFrom date of tripartite agreement.From date of tripartite agreement. The format is yyyy-mm-dd.
toDateDescriptionTo date of tripartite agreement.To date of tripartite agreement. The format is yyyy-mm-dd.
CdUpdateCashAccountReqDescriptionRequest to add a Cash AccountRequest to update a Cash Account. The cash account is identified by either (1) the internalCashAccountId, or (2) the combination of participantUnitId and currency.
UserHas been removed.

3.1 External Members

3.2 Clearing House

4 Event Messages

Message nameField nameAttribute nameChanged fromChanged to
AccountPositionEventactiveUserIdHas been removed.
positionEventKeyHas been removed.
DailyAccountSummaryDetailsEventtimestampHas been added.
tagallowedValuesCondType
commissionHas been added.
activeUserIdHas been removed.
AggregatedSummaryClearingMemberEventtagallowedValuesCondType
DescriptionPrice Tag.Price Tag that identifies the event.
businessDateHas been added.
timestampHas been added.
activeUserIdHas been removed.
AggregatedSummaryTradingMemberEventtagallowedValuesCondType
businessDateHas been added.
timestampHas been added.
activeUserIdHas been removed.
AccountTradeEventtradeDescriptionThe referenced Trade.
activeUserIdHas been removed.
subIdHas been removed.
RiskNodeEventchannelDescriptionThe channel this result was calculated for. Null is the default channel.The channel this result was calculated for. DEFAULT is the normal channel.
activeUserIdHas been removed.
CommissionEventHas been added.
WithdrawalNotificationEventactiveUserIdHas been removed.

4.1 Event Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
TradenextTradeIdsDescriptionList of forward referenced tradesList of forward referenced trade IDs
previousTradeIdsDescriptionList of backward referenced tradesList of backward referenced trade IDs
referenceDescriptionThe trade reference.The reference supplied with the trade.
AggregatedSummaryDetailsinternaltrue
commissionHas been added.

4.2 External Members

Message nameField nameAttribute nameChanged fromChanged to
GiveUpEventDescriptionThis event is for FourEyes from clearing system.This event is for Assign and Tripartite flow from RTC.
fourEyesIdDescriptionThe id of the risk node the message is published on.The ID of the Assign or Tripartite.
timeInitiatedDescriptionTime the action was initiated
timeCompleteDescriptionTime the action was completed
timeCancelledDescriptionTime the action was cancelled
activeUserIdHas been removed.

4.3 Clearing House

5 Trade Management Messages

Message nameField nameAttribute nameChanged fromChanged to
QueryTradesReqtradeBusinessDateFromDescriptionQuery trades from date.Query trades from date. Can be current or previous business day.
AllocateTradeReqDescriptionAllocate trade request.Allocate trade to another account.
AggregateTradesReqDescriptionMove trade request.Accumulate several trade.
CancelGiveUpReqfourEyesIdDescriptionFourEyes Id.The ID of the Assign or Tripartite.
ApproveGiveUpReqfourEyesIdDescriptionFourEyes Id.The ID of the Assign or Tripartite.
eventTypeHas been removed.
RejectGiveUpReqfourEyesIdDescriptionFourEyes Id.The ID of the Assign or Tripartite.
AddCommissionReqHas been added.
CancelCommissionReqHas been added.
RejectCommissionReqHas been added.

5.1 Trade Management Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
TradeResalphaCodeDescriptionCommon identifier code for derivate instrumentsCommon identifier code for derivative instruments
CommissionHas been added.

6 Pricing Messages

7 Risk Messages

7.1 External Members

7.2 Clearing House

8 Settlement Messages

Message nameField nameAttribute nameChanged fromChanged to
GetPaymentAdvicesReqDescriptionGet payment advices. Possibly for a particular clearer.Get payment advices for a particular clearing member.
bookmarkDescriptionThe bookmark refers to a random string of characters which mark a specific item in a list of data.The bookmark marks a specific item in a list of data. The bookmark received in the response should be used in next request to get next page of information.
pageSizeDescriptionThe preferred page size. If not set, use the default size.The preferred page size, this means max number of items in the response. If not set, the default pagesize is used.
GetPaymentAdvicesRspDescriptionResponse to the CreateWithdrawalConfirmations request.Response to the GetPaymentAdvicesReq request.
bookmarkDescriptionThe bookmark refers to a random string of characters which mark a specific item in a list of data.The bookmark marks a specific item in a list of data on the server. The bookmark received in the response should be used in next request to get next page of information.

8.1 External Members

Message nameField nameAttribute nameChanged fromChanged to
ReadyConfirmAvailableFXEventDescriptionPublish event to the CMs FX process is available.Event published to the CMs to inform that RTC is ready to receive information about FX collateral.
activeUserIdHas been removed.
RegisterFXCollateralReqDescriptionRegister FX Collateral.For clearing member to register FX Collateral.
RegisterFXCollateralRspstatusTextDescriptionAvailable Currency. The currency code according to ISO 4217.Description of the execution status.
CmBalancing1EventactiveUserIdHas been removed.
CmBalancing2EventactiveUserIdHas been removed.
8.1.1 External Members (Internal)
Message nameField nameAttribute nameChanged fromChanged to
FXCollateralinternaltrue
FXCollateralStatusinternaltrue
MemberBalance2feesDescriptionTotal net booking fee for the specified member ID.Total net booking fee for the specified member ID. A negative number means that the member will pay the amount.
commissionsHas been added.

8.2 Clearing House

9 Position Messages

9.1 External Members

9.2 Clearing House

10 Reference Data

10.1 General Messages

10.1.1 General Management Messages

Constant Groups

Constant group nameConstant nameAttribute nameChanged fromChanged to
CondTypeDescriptionPrice condition types.Price condition types. The value is a price tag that marks the market data values.
PositionReasonCOMMISSIONHas been added.
CommissionStatusHas been added.
SessionStatusFORCED_LOGOFFDescriptionUser session logout was forced. Caused by an operator killing the session.User session logout was forced. Caused by an operator terminating the session.
FeedSourceHas been removed.