Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
developers:fixapi.traderlogoutresponse [2025/08/12 19:26] – created rob | developers:fixapi.traderlogoutresponse [2025/08/12 19:29] (current) – rob | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | TraderLogoutResponse | + | ====== |
- | + | ||
- | RSS | + | |
- | Click to enable email notifications for this page | + | |
- | Logging out Traders | + | |
- | Under an established FIX Session, multiple traders/ | + | ===== Logging out Traders ===== |
+ | Under an established FIX Session, multiple traders/ | ||
- | A trader that has been successfully authenticated with a Trader Logon can be logged out by the Master User with a Trader Logout message. The FIX API responds to Trader Logouts with the Trader Logout Response message. | + | A trader that has been successfully authenticated with a Trader Logon can be logged out by the Master User with a **Trader Logout** message. The FIX API responds to Trader Logouts with the **Trader Logout Response** message. |
- | Responding to Trader Logouts | + | ===== Responding to Trader Logouts |
+ | 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/ | ||
- | The Trader Logout Response message identifies the trader (whose logout was attempted with a Trader Logout message) via the UserName | + | ^ Tag Name ^ Tag Number ^ Description |
+ | | UserName | ||
+ | | Text | 58 | T4 Description | ||
- | Tag Name Tag Number Description | + | 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). |
- | UserName 553 T4 User | + | |
- | Text 58 T4 Description of Trader Logout result | + | |
- | A successful attempt | + | Failure |
+ | The Trader Logout Response message may contain | ||
- | Failure to logout a trader will result in a failed Trader Logout Response message sent to the client. The Trader | + | A failed Trader Logout does **not** |
+ | 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. | ||
- | A failed Trader Logout does not result in a physical disconnection. 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 result | | ||
+ | | | Standard Trailer | Y | | | ||
- | Message Dictionary | + | ===== 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. | ||
- | Tag Field Name Req' | + | ---- |
- | Standard Header Y MsgType = UCJ | + | < |
- | 49 SenderCompID Y T4 Application Name (inbound trader login into FIX API server). T4 Firm Name (outbound trader login response from FIX API server). | + | Login Request from T4 FIX API Client |
- | 56 TargetCompID Y T4 Firm Name (inbound trader login into FIX API server). T4 Application Name (outbound trader login response from FIX API server). | + | 1 - LOGIN (in) |
- | Body Y | + | |
- | 553 UserName Y T4 User to be logged out. | + | |
- | 58 Text Y Description of Trader Logout result. | + | |
- | Standard Trailer Y | + | |
- | Sample | + | 34=1|49=T4Example|56=ctsdev|52=20160930-16: |
- | In this example, the T4 FIX API client requests the start of a FIX Session. The client enables the Multi-Trader mode (with Tag 372=UCG). The login request' | + | [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] | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | Successful | ||
+ | 2 - LOGIN (out) | ||
+ | |||
+ | 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 | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | Trader Logon Request from T4 FIX API Client | ||
+ | 3 - TRADERLOGIN (in) | ||
+ | |||
+ | 34=2|49=T4Example|56=ctsdev|50=Trader1|52=20160930-16: | ||
+ | |||
+ | [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 | ||
+ | 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 Logout Request from T4 FIX API Client | ||
+ | 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 (out) | ||
+ | |||
+ | 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:33:49.605 | ||
+ | [UserName] 553 = Trader1 | ||
+ | [Text] 58 = Success | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | Logout | ||
+ | 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 | ||
+ | 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: |