Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
developers:fixapi:traderlogoutresponse [2025/09/12 01:20] – ↷ Page moved and renamed from developers:fixapi.traderlogoutresponse to developers:fixapi:traderlogoutresponse chad | developers:fixapi:traderlogoutresponse [2025/09/17 01:03] (current) – chad | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | ===== Logging out Traders ===== | + | The Trader Logout message removes |
- | Under an established FIX Session, multiple traders/ | + | |
- | A trader that has been successfully authenticated with a Trader | + | ===== Prerequisites ===== |
+ | * Multi-Trader | ||
+ | * Target trader must be logged | ||
+ | | ||
- | ===== Responding to Trader Logouts | + | ===== Message Specification |
- | The Trader Logout Response message identifies the trader (whose logout was attempted with a Trader Logout message) via the **UserName** tag (Tag 553). | + | |
- | The success/ | + | |
- | ^ Tag Name ^ Tag Number ^ Description | + | **Message Direction: |
- | | UserName | + | |
- | | Text | 58 | T4 Description of Trader Logout result | | + | |
- | A successful attempt to log out a trader is acknowledged with a Trader Logout Response message that contains a **Success** description in the **Text** tag (Tag 58). | + | ^ Tag ^ Field Name ^ Type ^ Req'd ^ Description ^ |
+ | | | **Message Header** | | Y | MsgType = UCH | | ||
+ | | 109 | ClientID | String | O | Organization ID | | ||
+ | | 553 | UserName | String | Y | Trader to log out | | ||
+ | | | **Message Trailer** | | Y | | | ||
- | Failure to logout a trader will result in a failed Trader Logout Response message sent to the client. | + | ===== Sample Messages ===== |
- | The Trader Logout Response message may contain a short description of the failure in its **Text** tag (Tag 58). | + | |
- | A failed Trader Logout does **not** result in a physical disconnection. | + | **Trader Logout |
- | The FIX Session continues with the participation of the Master User and other traders that were previously authenticated and remained logged in. | + | |
- | The FIX Session can only be terminated by a **FIX Logout** message. | + | |
- | + | ||
- | ===== Message Dictionary ===== | + | |
- | ^ Tag ^ Field Name ^ Req'd ^ Comments | | + | |
- | | | Standard Header | + | |
- | | 49 | SenderCompID | + | |
- | | 56 | TargetCompID | + | |
- | | | Body | Y | | | + | |
- | | 553 | UserName | + | |
- | | 58 | Text | Y | Description of Trader Logout | + | |
- | | | Standard Trailer | Y | | | + | |
- | + | ||
- | ===== Sample ===== | + | |
- | In this example: | + | |
- | * The T4 FIX API client requests the start of a FIX Session. | + | |
- | * The client enables Multi-Trader mode (**Tag 372=UCG**). | + | |
- | * The login request' | + | |
- | * The client sends a Trader Logon to authenticate a new Trader/User under the current FIX Session. | + | |
- | * The Trader Logon succeeds (Trader Logon Response = Success). | + | |
- | * The client sends a **Trader Logout** message to log out this trader. | + | |
- | * The FIX API responds with Success as the trader was correctly identified. | + | |
- | * Finally, the client requests the termination of the FIX Session with a **FIX Logout** message, and the FIX API confirms the logout. | + | |
- | + | ||
- | ---- | + | |
< | < | ||
- | Login Request from T4 FIX API Client | + | 8=FIX.4.2|9=100|35=UCH|49=T4Example|56=ctsdev|50=Trader1|52=20160930-16: |
- | 1 - LOGIN (in) | + | 109=CTS|553=Trader1|10=123| |
- | + | ||
- | 34=1|49=T4Example|56=ctsdev|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 1 | + | |
- | [SenderCompID] 49 = T4Example | + | |
- | [TargetCompID] 56 = ctsdev | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [SecureData] 91 = 112A04B0-5AAF-42F4-994E-FA7CB959C60B | + | |
- | [SecureDataLen] 90 = 36 | + | |
- | [EncryptMethod] 98 = None | + | |
- | [HeartBtInt] 108 = 25 | + | |
- | [UserName] 553 = MasterUser | + | |
- | [Password] 554 = *** | + | |
- | [DefaultApplExtID] 1407 = 58BD-B00F-5805-98AA-BD46-0417-C2B8-9C5F | + | |
- | [NoMsgTypes] 384 = 1 | + | |
- | [RefMsgType] 372 = UCG (ENABLE_TRADER_LOGINS) | + | |
</ | </ | ||
+ | **Successful Response:** | ||
< | < | ||
- | Successful Login Response from T4 FIX API | + | 8=FIX.4.2|9=100|35=UCJ|49=ctsdev|56=T4Example|50=T4FIX|52=20160930-16: |
- | 2 - LOGIN (out) | + | 553=Trader1|58=Success|10=234| |
- | + | ||
- | 34=1|49=ctsdev|56=T4Example|50=T4FIX|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 1 | + | |
- | [SenderCompID] 49 = ctsdev | + | |
- | [TargetCompID] 56 = T4Example | + | |
- | [SenderSubID] 50 = T4FIX | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [EncryptMethod] 98 = 0 (NONE) | + | |
- | [HeartBtInt] 108 = 30 | + | |
- | [UserName] 553 = MasterUser | + | |
- | [Password] 554 = *** | + | |
- | [DefaultCstmApplVerID] 1408 = 4.3.62.0 | + | |
</ | </ | ||
- | < | + | ===== Notes ===== |
- | Trader Logon Request from T4 FIX API Client | + | |
- | 3 - TRADERLOGIN (in) | + | |
- | + | * FIX Logout | |
- | 34=2|49=T4Example|56=ctsdev|50=Trader1|52=20160930-16: | + | * Response type is Trader Logout Response (35=UCJ) |
- | + | ||
- | [MsgSeqNum] 34 = 2 | + | |
- | [SenderCompID] 49 = T4Example | + | |
- | [TargetCompID] 56 = ctsdev | + | |
- | [SenderSubID] 50 = Trader1 | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [SecureData] 91 = 112A04B0-5AAF-42F4-994E-FA7CB959C60B | + | |
- | [SecureDataLen] 90 = 36 | + | |
- | [ClientID] 109 = CTS | + | |
- | [UserName] 553 = Trader1 | + | |
- | [Password] 554 = *** | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | Successful Trader Logon Response from T4 FIX API | + | |
- | 4 - TRADERLOGINRESPONSE (out) | + | |
- | + | ||
- | 34=57|49=ctsdev|56=T4Example|50=T4FIX|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 57 | + | |
- | [SenderCompID] 49 = ctsdev | + | |
- | [TargetCompID] 56 = T4Example | + | |
- | [SenderSubID] 50 = T4FIX | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [UserName] 553 = Trader1 | + | |
- | [Text] 58 = Success | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | Trader | + | |
- | 5 - TRADERLOGOUT (in) | + | |
- | + | ||
- | 34=3|49=T4Example|56=ctsdev|50=Trader1|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 3 | + | |
- | [SenderCompID] 49 = T4Example | + | |
- | [TargetCompID] 56 = ctsdev | + | |
- | [SenderSubID] 50 = Trader1 | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [ClientID] 109 = CTS | + | |
- | [UserName] 553 = Trader1 | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | Successful | + | |
- | 6 - TRADERLOGOUTRESPONSE | + | |
- | + | ||
- | 34=58|49=ctsdev|56=T4Example|50=T4FIX|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 58 | + | |
- | [SenderCompID] 49 = ctsdev | + | |
- | [TargetCompID] 56 = T4Example | + | |
- | [SenderSubID] 50 = T4FIX | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [UserName] 553 = Trader1 | + | |
- | [Text] 58 = Success | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | Logout Request from T4 FIX API Client | + | |
- | 7 - LOGOUT (in) | + | |
- | + | ||
- | 34=4|49=T4Example|56=ctsdev|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 4 | + | |
- | [SenderCompID] 49 = T4Example | + | |
- | [TargetCompID] 56 = ctsdev | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | Successful Logout Response from T4 FIX API | + | |
- | 8 - LOGOUT (out) | + | |
- | + | ||
- | 34=59|49=ctsdev|56=T4Example|50=T4FIX|52=20160930-16: | + | |
- | + | ||
- | [MsgSeqNum] 34 = 59 | + | |
- | [SenderCompID] 49 = ctsdev | + | |
- | [TargetCompID] 56 = T4Example | + | |
- | [SenderSubID] 50 = T4FIX | + | |
- | [SendingTime] 52 = 20160930-16: | + | |
- | [Text] 58 = Successful logout upon request | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | [[developers: | + |