FIXEdge Administrative REST API

FIXEdge Administrative REST API
More information: https://www.b2bits.com/
Contact Info: sales@btobits.com
Version: 1.1.0
All rights reserved.
https://www.b2bits.com/trading_solutions/license.aspx

Access

Methods

[ Jump to Models ]

Table of Contents

BusinessLayer

Queues

Schedules

Service

Sessions

BusinessLayer

Up 
get /business_layer/routing_rules
(getBLRules)
Get content of BL_config.xml configuration file

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

500

Operation failed
Up 
post /business_layer/routing_rules/reload
(reloadBusinessLayerRoutingRules)
Reloads business layer routing rules.

Query parameters

history (optional)
Query Parameter — reload history or not

Return type

BLError

Example data

Content-Type: application/json
{
  "component" : "component",
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

empty JSON array if OK, otherwise list of errors occured BLError

500

An exception was generated by business layer
Up 
put /business_layer/routing_rules
(setBLRules)
Set content of BL_config.xml configuration file

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (optional)
Body Parameter —

Responses

200

OK

500

Operation failed

Queues

Up 
post /managed_queues/egress/{queueName}/flush
(flushEgressQueue)
Remove all queued messages

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Responses

200

OK

400

Managed queue is not registered

500

The storage is not initialized
Up 
get /managed_queues/egress
(getAllEgressQueues)
Get list of egress managed queues on FIX layer

Return type

array[QueueStatus]

Example data

Content-Type: application/json
[ {
  "QueuedMessages" : 0,
  "OnHold" : true,
  "TargetSession" : "TargetSession",
  "QueueName" : "QueueName",
  "IsProcessing" : true,
  "ScheduleName" : "ScheduleName"
}, {
  "QueuedMessages" : 0,
  "OnHold" : true,
  "TargetSession" : "TargetSession",
  "QueueName" : "QueueName",
  "IsProcessing" : true,
  "ScheduleName" : "ScheduleName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
get /managed_queues/schedules
(getAllManagedQueuesSchedules)
List all available schedules

Return type

NamedScheduleConfig

Example data

Content-Type: application/json
{
  "ScheduleName" : "ScheduleName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NamedScheduleConfig

500

Operation failed
Up 
get /managed_queues/egress/{queueName}
(getEgressQueueByName)
Obtain information about egress queue by its name

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Return type

QueueStatus

Example data

Content-Type: application/json
{
  "QueuedMessages" : 0,
  "OnHold" : true,
  "TargetSession" : "TargetSession",
  "QueueName" : "QueueName",
  "IsProcessing" : true,
  "ScheduleName" : "ScheduleName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK QueueStatus

400

Managed queue is not registered

500

The storage is not initialized
Up 
get /managed_queues/egress/{queueName}/messages
(getEgressQueueMessages)
Obtain messages from egress queue by its name

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Return type

array[QueueItem]

Example data

Content-Type: application/json
[ {
  "ClOrdID" : "ClOrdID",
  "ClientID" : "ClientID",
  "MessageText" : "MessageText",
  "MessageType" : "MessageType",
  "MessageId" : 0,
  "EnqueuedTimestamp" : 6
}, {
  "ClOrdID" : "ClOrdID",
  "ClientID" : "ClientID",
  "MessageText" : "MessageText",
  "MessageType" : "MessageType",
  "MessageId" : 0,
  "EnqueuedTimestamp" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Managed queue is not registered

500

The storage is not initialized
Up 
post /managed_queues/egress/{queueName}/hold
(holdEgressQueue)
Put managed queue on hold. Queued messages will not be delivered until hold is manually released

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Responses

200

OK

400

Managed queue is not registered

500

The storage is not initialized
Up 
delete /managed_queues/egress/{queueName}/messages
(removeEgressQueueMessages)
Delete messages from egress queue by message IDs

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body integer (required)
Body Parameter — JSON array of integers with message IDs

Return type

array[RemovedQueueItem]

Example data

Content-Type: application/json
[ {
  "IsRemoved" : true,
  "MessageId" : 0
}, {
  "IsRemoved" : true,
  "MessageId" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Managed queue is not registered

500

The storage is not initialized
Up 
delete /managed_queues/egress/{queueName}/hold
(unholdEgressQueue)
Release hold from queue. Queued messages will be immediately delivered if managed queue is not processing at the moment

Path parameters

queueName (required)
Path Parameter — identifier of managed queue

Responses

200

OK

400

Managed queue is not registered

500

The storage is not initialized

Schedules

Up 
post /schedules/{scheduleName}
(addSchedule)
Add new schedule

Path parameters

scheduleName (required)
Path Parameter — identifier of the schedule

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ScheduleConfig (required)
Body Parameter — Parameters of a schedule

Responses

200

OK

500

Operation failed
Up 
get /schedules
(getAllSchedules)
List all available schedules

Return type

NamedScheduleConfig

Example data

Content-Type: application/json
{
  "ScheduleName" : "ScheduleName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NamedScheduleConfig

500

Operation failed
Up 
get /schedules/{scheduleName}
(getSchedule)
Get schedule parameters

Path parameters

scheduleName (required)
Path Parameter — identifier of the schedule

Return type

NamedScheduleConfig

Example data

Content-Type: application/json
{
  "ScheduleName" : "ScheduleName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NamedScheduleConfig

404

Schedule with given name does not exist

500

Operation failed
Up 
put /schedules/{scheduleName}
(modifySchedule)
Modify existing schedule

Path parameters

scheduleName (required)
Path Parameter — identifier of the schedule

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ScheduleConfig (required)
Body Parameter — Parameters of a schedule

Responses

200

OK

404

Schedule with given name does not exist

500

Operation failed
Up 
delete /schedules/{scheduleName}
(removeSchedule)
Remove existing schedule

Path parameters

scheduleName (required)
Path Parameter — identifier of the schedule

Responses

200

OK

404

Schedule with given name does not exist

500

Operation failed

Service

Up 
get /service/started
(isServiceRunning)
Check if service is running and finished initialization

Responses

200

OK

404

Serivce is not fully initialized yet
Up 
delete /service/started
(shutdownService)
Shutdown service

Responses

200

OK

Sessions

Up 
post /sessions/sender/{sender}/target/{target}
Create new session (addSessionById)

Creates new session with given sender and target. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required. These properties are ignored for acceptor sessions.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionParams (optional)
Body Parameter — Session parameters (like in FIXEdge properties)

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Failure to create a session (e.g. sessions with the specified name already exists)
Up 
post /sessions
Create new session (addSessionByIdFromJSON)

Creates new session with given sender, target and optional qualifier from JSON body. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required. These properties are ignored for acceptor sessions.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionParams (optional)
Body Parameter — SessionId and Session parameters

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Failure to create a session (e.g. sessions with the specified name already exists)
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Create new session (addSessionByQualifiedId)

Creates new session with given sender, target and qualifier. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Note that for initiator sessions properties RemoteHost, RemotePort and HBI are required. These properties are ignored for acceptor sessions.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionParams (optional)
Body Parameter — Session parameters (like in FIXEdge properties)

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Failure to create a session (e.g. sessions with the specified name already exists)
Up 
get /sessions
Get list of all sessions (getAllSessions)

Return type

array[SessionData]

Example data

Content-Type: application/json
[ {
  "SenderCompID" : "SenderCompID",
  "IncomingMessagesLimit" : 0,
  "StorageType" : "StorageType",
  "InSeqNum" : 1,
  "RemotePort" : 39501,
  "OutgoingQueueSizeLimit" : 0,
  "TargetCompID" : "TargetCompID",
  "IncomingThroughputLimit" : 0,
  "AsyncProcessing" : true,
  "RecreateOnLogout" : true,
  "AsyncProcessingQueueSizeLimit" : 0,
  "SSL" : true,
  "ConfiguredName" : "ConfiguredName",
  "HBI" : 0,
  "Role" : "NA",
  "ExtraParams" : {
    "SenderSubId" : "SenderSubId",
    "ReconnectInterval" : 0,
    "MessagesStorageSize" : "",
    "DisableTCPBuffer" : "",
    "SocketSendBufSize" : 0,
    "SuppressDoubleResendRequest" : "",
    "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
    "ResendRequestBlockSize" : 1,
    "CyclicSwitchBackupConnection" : "",
    "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
    "Validation" : {
      "ProhibitUnknownTags" : "",
      "AllowZeroNumInGroup" : "",
      "IgnoreUnknownFields" : "",
      "IsEnabled" : "",
      "ProhibitDuplicatedTags" : "",
      "CheckRequiredGroupFields" : "",
      "ProhibitTagsWithoutValue" : "",
      "VerifyTagsValues" : "",
      "VerifyRepeatingGroupBounds" : ""
    },
    "SendCpuAffinity" : 0,
    "EncryptMethod" : "",
    "StorageType" : "StorageType",
    "UserNameTag" : 0,
    "CustomSessionType" : "CustomSessionType",
    "LogIncomingMessages" : "",
    "AggressiveReceiveDelay" : "",
    "HandleSeqNumAtLogon" : "",
    "SendLastMsgSeqNumProcessed" : "",
    "SocketPriority" : "SocketPriority",
    "SenderLocationID" : "SenderLocationID",
    "LogonMessageSessionQualifierTag" : 0,
    "KeepConnectionState" : "",
    "SendingTimestampUnit" : "SendingTimestampUnit",
    "Transport" : "Transport",
    "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
    "ReconnectMaxTries" : 0,
    "IgnoreSeqNumTooLowAtLogon" : "",
    "ConnectPort" : 48874,
    "ValidateCheckSum" : "",
    "AllowMessageWithoutPossDupFlag" : "",
    "ForcedReconnect" : "",
    "SocketBusyPollTime" : 0,
    "DeliverAppMessagesOutOfOrder" : "",
    "TargetSubId" : "TargetSubId",
    "TargetLocationID" : "TargetLocationID",
    "PasswordTag" : 0,
    "MaxMessagesAmountInBunch" : 0,
    "FixKey" : "FixKey",
    "GenerateCheckSum" : "",
    "HiddenLogonCredentials" : true,
    "Password" : "Password",
    "UseBlockingSockets" : "",
    "CpuAffinity" : 0,
    "SocketRecvBufSize" : 0,
    "EnableMessageRejecting" : "",
    "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
    "UseAsyncConnect" : "",
    "IntradayLogoutToleranceMode" : "",
    "ConnectAddress" : "ConnectAddress",
    "Username" : "Username",
    "ForceSeqNumReset" : "",
    "EnableAutoSwitchToBackupConnection" : ""
  },
  "OutSeqNum" : 1,
  "State" : "ESTABLISHED",
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "SSLCheckPrivateKey" : true,
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "Protocol" : "FIX_TCP",
  "TerminateOnLogout" : true
}, {
  "SenderCompID" : "SenderCompID",
  "IncomingMessagesLimit" : 0,
  "StorageType" : "StorageType",
  "InSeqNum" : 1,
  "RemotePort" : 39501,
  "OutgoingQueueSizeLimit" : 0,
  "TargetCompID" : "TargetCompID",
  "IncomingThroughputLimit" : 0,
  "AsyncProcessing" : true,
  "RecreateOnLogout" : true,
  "AsyncProcessingQueueSizeLimit" : 0,
  "SSL" : true,
  "ConfiguredName" : "ConfiguredName",
  "HBI" : 0,
  "Role" : "NA",
  "ExtraParams" : {
    "SenderSubId" : "SenderSubId",
    "ReconnectInterval" : 0,
    "MessagesStorageSize" : "",
    "DisableTCPBuffer" : "",
    "SocketSendBufSize" : 0,
    "SuppressDoubleResendRequest" : "",
    "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
    "ResendRequestBlockSize" : 1,
    "CyclicSwitchBackupConnection" : "",
    "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
    "Validation" : {
      "ProhibitUnknownTags" : "",
      "AllowZeroNumInGroup" : "",
      "IgnoreUnknownFields" : "",
      "IsEnabled" : "",
      "ProhibitDuplicatedTags" : "",
      "CheckRequiredGroupFields" : "",
      "ProhibitTagsWithoutValue" : "",
      "VerifyTagsValues" : "",
      "VerifyRepeatingGroupBounds" : ""
    },
    "SendCpuAffinity" : 0,
    "EncryptMethod" : "",
    "StorageType" : "StorageType",
    "UserNameTag" : 0,
    "CustomSessionType" : "CustomSessionType",
    "LogIncomingMessages" : "",
    "AggressiveReceiveDelay" : "",
    "HandleSeqNumAtLogon" : "",
    "SendLastMsgSeqNumProcessed" : "",
    "SocketPriority" : "SocketPriority",
    "SenderLocationID" : "SenderLocationID",
    "LogonMessageSessionQualifierTag" : 0,
    "KeepConnectionState" : "",
    "SendingTimestampUnit" : "SendingTimestampUnit",
    "Transport" : "Transport",
    "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
    "ReconnectMaxTries" : 0,
    "IgnoreSeqNumTooLowAtLogon" : "",
    "ConnectPort" : 48874,
    "ValidateCheckSum" : "",
    "AllowMessageWithoutPossDupFlag" : "",
    "ForcedReconnect" : "",
    "SocketBusyPollTime" : 0,
    "DeliverAppMessagesOutOfOrder" : "",
    "TargetSubId" : "TargetSubId",
    "TargetLocationID" : "TargetLocationID",
    "PasswordTag" : 0,
    "MaxMessagesAmountInBunch" : 0,
    "FixKey" : "FixKey",
    "GenerateCheckSum" : "",
    "HiddenLogonCredentials" : true,
    "Password" : "Password",
    "UseBlockingSockets" : "",
    "CpuAffinity" : 0,
    "SocketRecvBufSize" : 0,
    "EnableMessageRejecting" : "",
    "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
    "UseAsyncConnect" : "",
    "IntradayLogoutToleranceMode" : "",
    "ConnectAddress" : "ConnectAddress",
    "Username" : "Username",
    "ForceSeqNumReset" : "",
    "EnableAutoSwitchToBackupConnection" : ""
  },
  "OutSeqNum" : 1,
  "State" : "ESTABLISHED",
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "SSLCheckPrivateKey" : true,
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "Protocol" : "FIX_TCP",
  "TerminateOnLogout" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
get /sessions/state/dynamic
Get list of all sessions (getAllSessionsStream)

Return type

SessionsDataEvent

Example data

Content-Type: application/json
{
  "data" : [ {
    "SenderCompID" : "SenderCompID",
    "IncomingMessagesLimit" : 0,
    "StorageType" : "StorageType",
    "InSeqNum" : 1,
    "RemotePort" : 39501,
    "OutgoingQueueSizeLimit" : 0,
    "TargetCompID" : "TargetCompID",
    "IncomingThroughputLimit" : 0,
    "AsyncProcessing" : true,
    "RecreateOnLogout" : true,
    "AsyncProcessingQueueSizeLimit" : 0,
    "SSL" : true,
    "ConfiguredName" : "ConfiguredName",
    "HBI" : 0,
    "Role" : "NA",
    "ExtraParams" : {
      "SenderSubId" : "SenderSubId",
      "ReconnectInterval" : 0,
      "MessagesStorageSize" : "",
      "DisableTCPBuffer" : "",
      "SocketSendBufSize" : 0,
      "SuppressDoubleResendRequest" : "",
      "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
      "ResendRequestBlockSize" : 1,
      "CyclicSwitchBackupConnection" : "",
      "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
      "Validation" : {
        "ProhibitUnknownTags" : "",
        "AllowZeroNumInGroup" : "",
        "IgnoreUnknownFields" : "",
        "IsEnabled" : "",
        "ProhibitDuplicatedTags" : "",
        "CheckRequiredGroupFields" : "",
        "ProhibitTagsWithoutValue" : "",
        "VerifyTagsValues" : "",
        "VerifyRepeatingGroupBounds" : ""
      },
      "SendCpuAffinity" : 0,
      "EncryptMethod" : "",
      "StorageType" : "StorageType",
      "UserNameTag" : 0,
      "CustomSessionType" : "CustomSessionType",
      "LogIncomingMessages" : "",
      "AggressiveReceiveDelay" : "",
      "HandleSeqNumAtLogon" : "",
      "SendLastMsgSeqNumProcessed" : "",
      "SocketPriority" : "SocketPriority",
      "SenderLocationID" : "SenderLocationID",
      "LogonMessageSessionQualifierTag" : 0,
      "KeepConnectionState" : "",
      "SendingTimestampUnit" : "SendingTimestampUnit",
      "Transport" : "Transport",
      "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
      "ReconnectMaxTries" : 0,
      "IgnoreSeqNumTooLowAtLogon" : "",
      "ConnectPort" : 48874,
      "ValidateCheckSum" : "",
      "AllowMessageWithoutPossDupFlag" : "",
      "ForcedReconnect" : "",
      "SocketBusyPollTime" : 0,
      "DeliverAppMessagesOutOfOrder" : "",
      "TargetSubId" : "TargetSubId",
      "TargetLocationID" : "TargetLocationID",
      "PasswordTag" : 0,
      "MaxMessagesAmountInBunch" : 0,
      "FixKey" : "FixKey",
      "GenerateCheckSum" : "",
      "HiddenLogonCredentials" : true,
      "Password" : "Password",
      "UseBlockingSockets" : "",
      "CpuAffinity" : 0,
      "SocketRecvBufSize" : 0,
      "EnableMessageRejecting" : "",
      "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
      "UseAsyncConnect" : "",
      "IntradayLogoutToleranceMode" : "",
      "ConnectAddress" : "ConnectAddress",
      "Username" : "Username",
      "ForceSeqNumReset" : "",
      "EnableAutoSwitchToBackupConnection" : ""
    },
    "OutSeqNum" : 1,
    "State" : "ESTABLISHED",
    "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
    "SSLCheckPrivateKey" : true,
    "ActiveConnection" : "PRIMARY",
    "Qualifier" : "Qualifier",
    "Protocol" : "FIX_TCP",
    "TerminateOnLogout" : true
  }, {
    "SenderCompID" : "SenderCompID",
    "IncomingMessagesLimit" : 0,
    "StorageType" : "StorageType",
    "InSeqNum" : 1,
    "RemotePort" : 39501,
    "OutgoingQueueSizeLimit" : 0,
    "TargetCompID" : "TargetCompID",
    "IncomingThroughputLimit" : 0,
    "AsyncProcessing" : true,
    "RecreateOnLogout" : true,
    "AsyncProcessingQueueSizeLimit" : 0,
    "SSL" : true,
    "ConfiguredName" : "ConfiguredName",
    "HBI" : 0,
    "Role" : "NA",
    "ExtraParams" : {
      "SenderSubId" : "SenderSubId",
      "ReconnectInterval" : 0,
      "MessagesStorageSize" : "",
      "DisableTCPBuffer" : "",
      "SocketSendBufSize" : 0,
      "SuppressDoubleResendRequest" : "",
      "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
      "ResendRequestBlockSize" : 1,
      "CyclicSwitchBackupConnection" : "",
      "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
      "Validation" : {
        "ProhibitUnknownTags" : "",
        "AllowZeroNumInGroup" : "",
        "IgnoreUnknownFields" : "",
        "IsEnabled" : "",
        "ProhibitDuplicatedTags" : "",
        "CheckRequiredGroupFields" : "",
        "ProhibitTagsWithoutValue" : "",
        "VerifyTagsValues" : "",
        "VerifyRepeatingGroupBounds" : ""
      },
      "SendCpuAffinity" : 0,
      "EncryptMethod" : "",
      "StorageType" : "StorageType",
      "UserNameTag" : 0,
      "CustomSessionType" : "CustomSessionType",
      "LogIncomingMessages" : "",
      "AggressiveReceiveDelay" : "",
      "HandleSeqNumAtLogon" : "",
      "SendLastMsgSeqNumProcessed" : "",
      "SocketPriority" : "SocketPriority",
      "SenderLocationID" : "SenderLocationID",
      "LogonMessageSessionQualifierTag" : 0,
      "KeepConnectionState" : "",
      "SendingTimestampUnit" : "SendingTimestampUnit",
      "Transport" : "Transport",
      "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
      "ReconnectMaxTries" : 0,
      "IgnoreSeqNumTooLowAtLogon" : "",
      "ConnectPort" : 48874,
      "ValidateCheckSum" : "",
      "AllowMessageWithoutPossDupFlag" : "",
      "ForcedReconnect" : "",
      "SocketBusyPollTime" : 0,
      "DeliverAppMessagesOutOfOrder" : "",
      "TargetSubId" : "TargetSubId",
      "TargetLocationID" : "TargetLocationID",
      "PasswordTag" : 0,
      "MaxMessagesAmountInBunch" : 0,
      "FixKey" : "FixKey",
      "GenerateCheckSum" : "",
      "HiddenLogonCredentials" : true,
      "Password" : "Password",
      "UseBlockingSockets" : "",
      "CpuAffinity" : 0,
      "SocketRecvBufSize" : 0,
      "EnableMessageRejecting" : "",
      "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
      "UseAsyncConnect" : "",
      "IntradayLogoutToleranceMode" : "",
      "ConnectAddress" : "ConnectAddress",
      "Username" : "Username",
      "ForceSeqNumReset" : "",
      "EnableAutoSwitchToBackupConnection" : ""
    },
    "OutSeqNum" : 1,
    "State" : "ESTABLISHED",
    "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
    "SSLCheckPrivateKey" : true,
    "ActiveConnection" : "PRIMARY",
    "Qualifier" : "Qualifier",
    "Protocol" : "FIX_TCP",
    "TerminateOnLogout" : true
  } ],
  "event" : "event"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionsDataEvent
Up 
get /sessions/sender/{sender}/target/{target}/output-messages
(getOutputMessagesOfSessionById)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the array contains a Base64 encoded FIX message.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Return type

array[byte[]]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
get /sessions/{configuredName}/output-messages
(getOutputMessagesOfSessionByName)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the array contains a Base64 encoded FIX message.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Return type

array[byte[]]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/output-messages
(getOutputMessagesOfSessionByQualifiedId)
Reads last 1000 output messages for the session. The messages are returns as JSON array, each element of the array contains a Base64 encoded FIX message.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Return type

array[byte[]]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
get /sessions/sender/{sender}/target/{target}
Get info on single session (getSessionById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Return type

SessionData

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "IncomingMessagesLimit" : 0,
  "StorageType" : "StorageType",
  "InSeqNum" : 1,
  "RemotePort" : 39501,
  "OutgoingQueueSizeLimit" : 0,
  "TargetCompID" : "TargetCompID",
  "IncomingThroughputLimit" : 0,
  "AsyncProcessing" : true,
  "RecreateOnLogout" : true,
  "AsyncProcessingQueueSizeLimit" : 0,
  "SSL" : true,
  "ConfiguredName" : "ConfiguredName",
  "HBI" : 0,
  "Role" : "NA",
  "ExtraParams" : {
    "SenderSubId" : "SenderSubId",
    "ReconnectInterval" : 0,
    "MessagesStorageSize" : "",
    "DisableTCPBuffer" : "",
    "SocketSendBufSize" : 0,
    "SuppressDoubleResendRequest" : "",
    "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
    "ResendRequestBlockSize" : 1,
    "CyclicSwitchBackupConnection" : "",
    "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
    "Validation" : {
      "ProhibitUnknownTags" : "",
      "AllowZeroNumInGroup" : "",
      "IgnoreUnknownFields" : "",
      "IsEnabled" : "",
      "ProhibitDuplicatedTags" : "",
      "CheckRequiredGroupFields" : "",
      "ProhibitTagsWithoutValue" : "",
      "VerifyTagsValues" : "",
      "VerifyRepeatingGroupBounds" : ""
    },
    "SendCpuAffinity" : 0,
    "EncryptMethod" : "",
    "StorageType" : "StorageType",
    "UserNameTag" : 0,
    "CustomSessionType" : "CustomSessionType",
    "LogIncomingMessages" : "",
    "AggressiveReceiveDelay" : "",
    "HandleSeqNumAtLogon" : "",
    "SendLastMsgSeqNumProcessed" : "",
    "SocketPriority" : "SocketPriority",
    "SenderLocationID" : "SenderLocationID",
    "LogonMessageSessionQualifierTag" : 0,
    "KeepConnectionState" : "",
    "SendingTimestampUnit" : "SendingTimestampUnit",
    "Transport" : "Transport",
    "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
    "ReconnectMaxTries" : 0,
    "IgnoreSeqNumTooLowAtLogon" : "",
    "ConnectPort" : 48874,
    "ValidateCheckSum" : "",
    "AllowMessageWithoutPossDupFlag" : "",
    "ForcedReconnect" : "",
    "SocketBusyPollTime" : 0,
    "DeliverAppMessagesOutOfOrder" : "",
    "TargetSubId" : "TargetSubId",
    "TargetLocationID" : "TargetLocationID",
    "PasswordTag" : 0,
    "MaxMessagesAmountInBunch" : 0,
    "FixKey" : "FixKey",
    "GenerateCheckSum" : "",
    "HiddenLogonCredentials" : true,
    "Password" : "Password",
    "UseBlockingSockets" : "",
    "CpuAffinity" : 0,
    "SocketRecvBufSize" : 0,
    "EnableMessageRejecting" : "",
    "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
    "UseAsyncConnect" : "",
    "IntradayLogoutToleranceMode" : "",
    "ConnectAddress" : "ConnectAddress",
    "Username" : "Username",
    "ForceSeqNumReset" : "",
    "EnableAutoSwitchToBackupConnection" : ""
  },
  "OutSeqNum" : 1,
  "State" : "ESTABLISHED",
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "SSLCheckPrivateKey" : true,
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "Protocol" : "FIX_TCP",
  "TerminateOnLogout" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionData

500

Session with the specified name does not exists
Up 
get /sessions/{configuredName}
Get info on single session (getSessionByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Return type

SessionData

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "IncomingMessagesLimit" : 0,
  "StorageType" : "StorageType",
  "InSeqNum" : 1,
  "RemotePort" : 39501,
  "OutgoingQueueSizeLimit" : 0,
  "TargetCompID" : "TargetCompID",
  "IncomingThroughputLimit" : 0,
  "AsyncProcessing" : true,
  "RecreateOnLogout" : true,
  "AsyncProcessingQueueSizeLimit" : 0,
  "SSL" : true,
  "ConfiguredName" : "ConfiguredName",
  "HBI" : 0,
  "Role" : "NA",
  "ExtraParams" : {
    "SenderSubId" : "SenderSubId",
    "ReconnectInterval" : 0,
    "MessagesStorageSize" : "",
    "DisableTCPBuffer" : "",
    "SocketSendBufSize" : 0,
    "SuppressDoubleResendRequest" : "",
    "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
    "ResendRequestBlockSize" : 1,
    "CyclicSwitchBackupConnection" : "",
    "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
    "Validation" : {
      "ProhibitUnknownTags" : "",
      "AllowZeroNumInGroup" : "",
      "IgnoreUnknownFields" : "",
      "IsEnabled" : "",
      "ProhibitDuplicatedTags" : "",
      "CheckRequiredGroupFields" : "",
      "ProhibitTagsWithoutValue" : "",
      "VerifyTagsValues" : "",
      "VerifyRepeatingGroupBounds" : ""
    },
    "SendCpuAffinity" : 0,
    "EncryptMethod" : "",
    "StorageType" : "StorageType",
    "UserNameTag" : 0,
    "CustomSessionType" : "CustomSessionType",
    "LogIncomingMessages" : "",
    "AggressiveReceiveDelay" : "",
    "HandleSeqNumAtLogon" : "",
    "SendLastMsgSeqNumProcessed" : "",
    "SocketPriority" : "SocketPriority",
    "SenderLocationID" : "SenderLocationID",
    "LogonMessageSessionQualifierTag" : 0,
    "KeepConnectionState" : "",
    "SendingTimestampUnit" : "SendingTimestampUnit",
    "Transport" : "Transport",
    "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
    "ReconnectMaxTries" : 0,
    "IgnoreSeqNumTooLowAtLogon" : "",
    "ConnectPort" : 48874,
    "ValidateCheckSum" : "",
    "AllowMessageWithoutPossDupFlag" : "",
    "ForcedReconnect" : "",
    "SocketBusyPollTime" : 0,
    "DeliverAppMessagesOutOfOrder" : "",
    "TargetSubId" : "TargetSubId",
    "TargetLocationID" : "TargetLocationID",
    "PasswordTag" : 0,
    "MaxMessagesAmountInBunch" : 0,
    "FixKey" : "FixKey",
    "GenerateCheckSum" : "",
    "HiddenLogonCredentials" : true,
    "Password" : "Password",
    "UseBlockingSockets" : "",
    "CpuAffinity" : 0,
    "SocketRecvBufSize" : 0,
    "EnableMessageRejecting" : "",
    "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
    "UseAsyncConnect" : "",
    "IntradayLogoutToleranceMode" : "",
    "ConnectAddress" : "ConnectAddress",
    "Username" : "Username",
    "ForceSeqNumReset" : "",
    "EnableAutoSwitchToBackupConnection" : ""
  },
  "OutSeqNum" : 1,
  "State" : "ESTABLISHED",
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "SSLCheckPrivateKey" : true,
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "Protocol" : "FIX_TCP",
  "TerminateOnLogout" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionData

500

Session with the specified name does not exists
Up 
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Get info on single session (getSessionByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Return type

SessionData

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "IncomingMessagesLimit" : 0,
  "StorageType" : "StorageType",
  "InSeqNum" : 1,
  "RemotePort" : 39501,
  "OutgoingQueueSizeLimit" : 0,
  "TargetCompID" : "TargetCompID",
  "IncomingThroughputLimit" : 0,
  "AsyncProcessing" : true,
  "RecreateOnLogout" : true,
  "AsyncProcessingQueueSizeLimit" : 0,
  "SSL" : true,
  "ConfiguredName" : "ConfiguredName",
  "HBI" : 0,
  "Role" : "NA",
  "ExtraParams" : {
    "SenderSubId" : "SenderSubId",
    "ReconnectInterval" : 0,
    "MessagesStorageSize" : "",
    "DisableTCPBuffer" : "",
    "SocketSendBufSize" : 0,
    "SuppressDoubleResendRequest" : "",
    "MaskedTags" : [ "MaskedTags", "MaskedTags" ],
    "ResendRequestBlockSize" : 1,
    "CyclicSwitchBackupConnection" : "",
    "RawDataTagProcessingStrategies" : "RawDataTagProcessingStrategies",
    "Validation" : {
      "ProhibitUnknownTags" : "",
      "AllowZeroNumInGroup" : "",
      "IgnoreUnknownFields" : "",
      "IsEnabled" : "",
      "ProhibitDuplicatedTags" : "",
      "CheckRequiredGroupFields" : "",
      "ProhibitTagsWithoutValue" : "",
      "VerifyTagsValues" : "",
      "VerifyRepeatingGroupBounds" : ""
    },
    "SendCpuAffinity" : 0,
    "EncryptMethod" : "",
    "StorageType" : "StorageType",
    "UserNameTag" : 0,
    "CustomSessionType" : "CustomSessionType",
    "LogIncomingMessages" : "",
    "AggressiveReceiveDelay" : "",
    "HandleSeqNumAtLogon" : "",
    "SendLastMsgSeqNumProcessed" : "",
    "SocketPriority" : "SocketPriority",
    "SenderLocationID" : "SenderLocationID",
    "LogonMessageSessionQualifierTag" : 0,
    "KeepConnectionState" : "",
    "SendingTimestampUnit" : "SendingTimestampUnit",
    "Transport" : "Transport",
    "SourceIPaddress" : [ "SourceIPaddress", "SourceIPaddress" ],
    "ReconnectMaxTries" : 0,
    "IgnoreSeqNumTooLowAtLogon" : "",
    "ConnectPort" : 48874,
    "ValidateCheckSum" : "",
    "AllowMessageWithoutPossDupFlag" : "",
    "ForcedReconnect" : "",
    "SocketBusyPollTime" : 0,
    "DeliverAppMessagesOutOfOrder" : "",
    "TargetSubId" : "TargetSubId",
    "TargetLocationID" : "TargetLocationID",
    "PasswordTag" : 0,
    "MaxMessagesAmountInBunch" : 0,
    "FixKey" : "FixKey",
    "GenerateCheckSum" : "",
    "HiddenLogonCredentials" : true,
    "Password" : "Password",
    "UseBlockingSockets" : "",
    "CpuAffinity" : 0,
    "SocketRecvBufSize" : 0,
    "EnableMessageRejecting" : "",
    "StorageRecoveryStrategy" : "StorageRecoveryStrategy",
    "UseAsyncConnect" : "",
    "IntradayLogoutToleranceMode" : "",
    "ConnectAddress" : "ConnectAddress",
    "Username" : "Username",
    "ForceSeqNumReset" : "",
    "EnableAutoSwitchToBackupConnection" : ""
  },
  "OutSeqNum" : 1,
  "State" : "ESTABLISHED",
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "SSLCheckPrivateKey" : true,
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "Protocol" : "FIX_TCP",
  "TerminateOnLogout" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionData

500

Session with the specified name does not exists
Up 
get /sessions/sender/{sender}/target/{target}/statistics
Get single session's statistics (getSessionStatisticsById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Return type

SessionStatistics

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "ReceivedMessages" : 0,
  "CurrentProcessingQueueSize" : 0,
  "TargetCompID" : "TargetCompID",
  "SentMessages" : 0,
  "Qualifier" : "Qualifier",
  "IncomingThroughput" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatistics

500

Cannot find the session with the specified ID
Up 
get /sessions/{configuredName}/statistics
Get single session's statistics (getSessionStatisticsByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Return type

SessionStatistics

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "ReceivedMessages" : 0,
  "CurrentProcessingQueueSize" : 0,
  "TargetCompID" : "TargetCompID",
  "SentMessages" : 0,
  "Qualifier" : "Qualifier",
  "IncomingThroughput" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatistics

400

Session with the specified name does not exists
Up 
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/statistics
Get single session's statistics (getSessionStatisticsByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Return type

SessionStatistics

Example data

Content-Type: application/json
{
  "SenderCompID" : "SenderCompID",
  "ReceivedMessages" : 0,
  "CurrentProcessingQueueSize" : 0,
  "TargetCompID" : "TargetCompID",
  "SentMessages" : 0,
  "Qualifier" : "Qualifier",
  "IncomingThroughput" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatistics

500

Cannot find the session with the specified ID
Up 
get /sessions/sender/{sender}/target/{target}/status
Get single session's status (getSessionStatusById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Return type

SessionStatus

Example data

Content-Type: application/json
{
  "Status" : "ESTABLISHED",
  "SenderCompID" : "SenderCompID",
  "InSeqNum" : 1,
  "OutSeqNum" : 1,
  "SessionCreated" : true,
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "TargetCompID" : "TargetCompID",
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "ConfiguredName" : "ConfiguredName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatus

500

Cannot find the session with the specified ID
Up 
get /sessions/{configuredName}/status
Get single session's status (getSessionStatusByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Return type

SessionStatus

Example data

Content-Type: application/json
{
  "Status" : "ESTABLISHED",
  "SenderCompID" : "SenderCompID",
  "InSeqNum" : 1,
  "OutSeqNum" : 1,
  "SessionCreated" : true,
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "TargetCompID" : "TargetCompID",
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "ConfiguredName" : "ConfiguredName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatus

400

Session with the specified name does not exists
Up 
get /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/status
Get single session's status (getSessionStatusByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Return type

SessionStatus

Example data

Content-Type: application/json
{
  "Status" : "ESTABLISHED",
  "SenderCompID" : "SenderCompID",
  "InSeqNum" : 1,
  "OutSeqNum" : 1,
  "SessionCreated" : true,
  "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
  "TargetCompID" : "TargetCompID",
  "ActiveConnection" : "PRIMARY",
  "Qualifier" : "Qualifier",
  "ConfiguredName" : "ConfiguredName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatus

500

Cannot find the session with the specified ID
Up 
get /monitoring
Get list of TA and them sessions (listenDynamicState)

Query parameters

poll_period (optional)
Query Parameter — The period of polling the session parameters (which require polling) in ms. By default - 1 second. default: 1000
log_level (optional)
Query Parameter — The level for log events. Valid values : none, warn. By default - none. default: none

Return type

array[MonitoringEvent]

Example data

Content-Type: application/json
[ {
  "event" : ""
}, {
  "event" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
put /sessions/sender/{sender}/target/{target}
Modify existing session (modifySessionById)
Modifies new session with given sender and target. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionUpdatableParams (optional)
Body Parameter — Session parameters (like in FIXEdge properties)

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

404

Session does not exist

500

Failure to modify a session
Up 
put /sessions/{configuredName}
Modify existing session (modifySessionByName)
Modifies new session with given ConfiguredName. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionUpdatableParams (optional)
Body Parameter — Session parameters (like in FIXEdge properties)

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

404

Session does not exist

500

Failure to modify a session
Up 
put /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}
Modify existing session (modifySessionByQualifiedId)
Modifies new session with given sender, target and qualifier. For detailed description of remaining parameters see https://kb.b2bits.com/display/B2BITS/Configuring+FIX+Sessions.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionUpdatableParams (optional)
Body Parameter — Session parameters (like in FIXEdge properties)

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

404

Session does not exist

500

Failure to modify a session
Up 
post /sessions/{configuredName}/sequence-numbers/reset
Reset sequence numbers for the session. (resetSequenceNumbersOfSessionByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Responses

200

OK

400

Bad request

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/sequence-numbers/reset
Reset sequence numbers for the session. (resetSequenceNumbersOfSessionByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Responses

200

OK

400

Bad request

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/restart
Restart session (restartSessionById)
Restarts session with given sender, target and qualifier and resets sequence numbers if requested.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Query parameters

seq_num_reset (optional)
Query Parameter — enables sequence number resetting
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Operation failed, e.g. session does not exist
Up 
post /sessions/{configuredName}/restart
Restart session (restartSessionByName)
Restarts session with given sender, target and qualifier and resets sequence numbers if requested.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Query parameters

seq_num_reset (optional)
Query Parameter — enables sequence number resetting
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session
send_logout (required)
Query Parameter — perform nongraceful session termination if false
logout_reason (required)
Query Parameter — logout reason description

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/restart
Restart session (restartSessionByQualifiedId)
Restarts session with given sender, target and qualifier and resets sequence numbers if requested.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Query parameters

seq_num_reset (optional)
Query Parameter — enables sequence number resetting
in_seq_num (optional)
Query Parameter — sets specific inbound sequence number for session
out_seq_num (optional)
Query Parameter — sets specific outbound sequence number for session

Responses

200

OK

400

Bad request (e.g. mandatory parameters are missing)

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/output-messages
(sendMessageToSessionById)
Sends message to the session;s output channel.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ByteArray (required)
Body Parameter — JSON array of strings with Base64 encoded messages.

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
post /sessions/{configuredName}/output-messages
(sendMessageToSessionByName)
Sends message to the session;s output channel.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ByteArray (required)
Body Parameter — JSON array of strings with Base64 encoded messages.

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/output-messages
(sendMessageToSessionByQualifiedId)
Sends message to the session's output channel.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ByteArray (required)
Body Parameter — JSON array of strings with Base64 encoded messages.

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
get /sessions/metrics/{interval}
Poll all sessions' metrics (in and out sequence numbers) using interval (sessionsMetricsIntervalGet)

Path parameters

interval (required)
Path Parameter —

Return type

SessionStatusesEvent

Example data

Content-Type: application/json
{
  "data" : [ {
    "Status" : "ESTABLISHED",
    "SenderCompID" : "SenderCompID",
    "InSeqNum" : 1,
    "OutSeqNum" : 1,
    "SessionCreated" : true,
    "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
    "TargetCompID" : "TargetCompID",
    "ActiveConnection" : "PRIMARY",
    "Qualifier" : "Qualifier",
    "ConfiguredName" : "ConfiguredName"
  }, {
    "Status" : "ESTABLISHED",
    "SenderCompID" : "SenderCompID",
    "InSeqNum" : 1,
    "OutSeqNum" : 1,
    "SessionCreated" : true,
    "AppProtocolBaseVersion" : "AppProtocolBaseVersion",
    "TargetCompID" : "TargetCompID",
    "ActiveConnection" : "PRIMARY",
    "Qualifier" : "Qualifier",
    "ConfiguredName" : "ConfiguredName"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionStatusesEvent
Up 
put /sessions/sender/{sender}/target/{target}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionSequenceNumbers (required)
Body Parameter — <ul> <li>All properties of this object except <code>InSeqNum</code> and <code>OutSeqNum</code> are ignored.</li> <li>If the object contains field <code>InSeqNum</code> then the input sequence number of the session is changed to the value of the field. If <code>InSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If the object contains field <code>OutSeqNum</code> then the output sequence number of the session is changed to the value of the field. If <code>OutSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If neither <code>InSeqNum</code> nor <code>OutSeqNum</code> is present then sequence numbers are reset.</li> </ul>

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
put /sessions/{configuredName}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionSequenceNumbers (required)
Body Parameter — <ul> <li>All properties of this object except <code>InSeqNum</code> and <code>OutSeqNum</code> are ignored.</li> <li>If the object contains field <code>InSeqNum</code> then the input sequence number of the session is changed to the value of the field. If <code>InSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If the object contains field <code>OutSeqNum</code> then the output sequence number of the session is changed to the value of the field. If <code>OutSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If neither <code>InSeqNum</code> nor <code>OutSeqNum</code> is present then sequence numbers are reset.</li> </ul>

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
put /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/sequence-numbers
Modify input and/or output sequence numbers of the session. (setSequenceNumbersOfSessionByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SessionSequenceNumbers (required)
Body Parameter — <ul> <li>All properties of this object except <code>InSeqNum</code> and <code>OutSeqNum</code> are ignored.</li> <li>If the object contains field <code>InSeqNum</code> then the input sequence number of the session is changed to the value of the field. If <code>InSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If the object contains field <code>OutSeqNum</code> then the output sequence number of the session is changed to the value of the field. If <code>OutSeqNum</code> is present its value must be convertible to an unsigned integer.</li> <li>If neither <code>InSeqNum</code> nor <code>OutSeqNum</code> is present then sequence numbers are reset.</li> </ul>

Responses

200

OK

400

Bad request, e.g. body does not contain a JSON object

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/started
(startSessionById)
Starts session identified by given sender-target.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Query parameters

seq_num_reset (optional)
Query Parameter — enables sequence number resetting

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
post /sessions/{configuredName}/started
(startSessionByName)
Starts session identified by given session name.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Query parameters

seq_num_reset (optional)
Query Parameter — enables sequence number resetting

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/started
(startSessionByQualifiedId)
Starts session identified by given sender-target-qualifier.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
delete /sessions/sender/{sender}/target/{target}/started
(stopSessionById)
Stops session identified by given sender-target.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Query parameters

send_logout (required)
Query Parameter — perform nongraceful session termination if false
logout_reason (required)
Query Parameter — logout reason description

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
delete /sessions/{configuredName}/started
(stopSessionByName)
Stops session identified by given session name.

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Query parameters

send_logout (required)
Query Parameter — perform nongraceful session termination if false
logout_reason (required)
Query Parameter — logout reason description

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
delete /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/started
(stopSessionByQualifiedId)
Stops session identified by given sender-target-qualifier.

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Query parameters

send_logout (required)
Query Parameter — perform nongraceful session termination if false
logout_reason (required)
Query Parameter — logout reason description

Responses

200

OK

500

Operation failed, e.g. session does not exist
Up 
post /sessions/sender/{sender}/target/{target}/connection/backup
Switch session to backup connection (switchConnectionToBackupById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Responses

200

OK (switch has been successful or specified session already uses backup connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up 
post /sessions/{configuredName}/connection/backup
Switch session to backup connection (switchConnectionToBackupByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Responses

200

OK (switch has been successful or specified session already uses backup connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/connection/backup
Switch session to backup connection (switchConnectionToBackupByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Responses

200

OK (switch has been successful or specified session already uses backup connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session or initiator session is missing backup properties)
Up 
post /sessions/sender/{sender}/target/{target}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryById)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side

Responses

200

OK (switch has been successful or specified session already uses primary connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session)
Up 
post /sessions/{configuredName}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryByName)

Path parameters

configuredName (required)
Path Parameter — name of the session specified by <code>ConfiguredName</code> property during session creation

Responses

200

OK (switch has been successful or specified session already uses primary connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session)
Up 
post /sessions/sender/{sender}/target/{target}/qualifier/{qualifier}/connection/primary
Switch session to primary connection (switchConnectionToPrimaryByQualifiedId)

Path parameters

sender (required)
Path Parameter — identifier of session sender side
target (required)
Path Parameter — identifier of session target side
qualifier (required)
Path Parameter — identifier to allow multiple sessions with the same sender and target identifiers

Responses

200

OK (switch has been successful or specified session already uses primary connection)

400

Session with such sessionId has not been found

500

Operation failed (e.g. applied to acceptor session)

Models

[ Jump to Methods ]

Table of Contents

  1. AdaptorDynamicState
  2. AdaptorPollableDynamicState
  3. AdaptorSessionDynamicState
  4. AdaptorSessionPollableDynamicState
  5. AdaptorsDynamicStateEvent
  6. AdaptorsPollableDynamicStateEvent
  7. BLError
  8. LogEvent
  9. MonitoringEvent
  10. MonitoringEventType
  11. NamedScheduleConfig
  12. QueueItem
  13. QueueStatus
  14. RemovedQueueItem
  15. ScheduleConfig
  16. SessionActiveConnection - Active connection to use
  17. SessionBackupParameters
  18. SessionData
  19. SessionExtraParameters
  20. SessionParams
  21. SessionRole - Role of a session
  22. SessionSequenceNumbers
  23. SessionState - State of a session
  24. SessionStatistics
  25. SessionStatus
  26. SessionStatusesEvent
  27. SessionUpdatableParams
  28. SessionsDataEvent
  29. StatusGroup
  30. UnderlyingProtocol
  31. ValidationParameters

AdaptorDynamicState Up

AdaptorName (optional)
String
Sessions (optional)
array[AdaptorSessionDynamicState]

AdaptorPollableDynamicState Up

AdaptorName (optional)
String
Sessions (optional)
array[AdaptorSessionPollableDynamicState]

AdaptorSessionDynamicState Up

AdaptorSessionPollableDynamicState Up

AdaptorsDynamicStateEvent Up

data (optional)
array[AdaptorDynamicState]

AdaptorsPollableDynamicStateEvent Up

data (optional)
array[AdaptorPollableDynamicState]

BLError Up

component (optional)
String
error (optional)
String

LogEvent Up

level (optional)
String
Enum:
WARN
ERROR
logger (optional)
String
message (optional)
String

MonitoringEvent Up

event (optional)
MonitoringEventType

MonitoringEventType Up

NamedScheduleConfig Up

StartTime (optional)
String
ConnectTime (optional)
String
DisconnectTime (optional)
String
TerminateTime (optional)
String
DaysOff (optional)
String
TimeZone (optional)
String
ScheduleName (optional)
String

QueueItem Up

MessageId (optional)
Integer
MessageType (optional)
String
ClientID (optional)
String
ClOrdID (optional)
String
MessageText (optional)
String
EnqueuedTimestamp (optional)
Integer

QueueStatus Up

QueueName (optional)
String
ScheduleName (optional)
String
TargetSession (optional)
String
QueuedMessages (optional)
Integer
IsProcessing (optional)
Boolean
OnHold (optional)
Boolean

RemovedQueueItem Up

MessageId (optional)
Integer
IsRemoved (optional)
Boolean

ScheduleConfig Up

StartTime (optional)
String
ConnectTime (optional)
String
DisconnectTime (optional)
String
TerminateTime (optional)
String
DaysOff (optional)
String
TimeZone (optional)
String

SessionActiveConnection - Active connection to use Up

SessionBackupParameters Up

HBI (optional)
Integer Heartbeat invterval (in seconds). Only required for initiator sessions
RemoteHost (optional)
String Only required for initiator sessions
RemotePort (optional)
Integer Only required for initiator sessions
ExtraSessionParams (optional)
SessionExtraParameters

SessionData Up

ConfiguredName (optional)
String
Role (optional)
SessionRole
State (optional)
SessionState
SenderCompID (optional)
String
TargetCompID (optional)
String
Qualifier (optional)
String
AppProtocolBaseVersion (optional)
String
Protocol (optional)
UnderlyingProtocol
HBI (optional)
Integer Heartbeat interval (in seconds)
RemotePort (optional)
Integer
InSeqNum (optional)
Integer
OutSeqNum (optional)
Integer
RecreateOnLogout (optional)
Boolean
TerminateOnLogout (optional)
Boolean
StorageType (optional)
String
ActiveConnection (optional)
SessionActiveConnection
SSL (optional)
Boolean
SSLCheckPrivateKey (optional)
Boolean
IncomingMessagesLimit (optional)
Integer
OutgoingQueueSizeLimit (optional)
Integer
IncomingThroughputLimit (optional)
Integer
AsyncProcessing (optional)
Boolean
AsyncProcessingQueueSizeLimit (optional)
Integer
ExtraParams (optional)
SessionExtraParameters

SessionExtraParameters Up

SenderSubId (optional)
String
TargetSubId (optional)
String
SenderLocationID (optional)
String
TargetLocationID (optional)
String
Username (optional)
String
Password (optional)
String
UserNameTag (optional)
Integer
HiddenLogonCredentials (optional)
Boolean
FixKey (optional)
String
CustomSessionType (optional)
String
SendingTimestampUnit (optional)
String
PasswordTag (optional)
Integer
MaskedTags (optional)
array[String]
SourceIPaddress (optional)
array[String]
IntradayLogoutToleranceMode (optional)
Boolean
ForceSeqNumReset (optional)
String
EncryptMethod (optional)
String
ForcedReconnect (optional)
Boolean
EnableMessageRejecting (optional)
Boolean Reject messages if server is unable to send them in a specified time period or disconnected
IgnoreSeqNumTooLowAtLogon (optional)
Boolean Ignore SeqNum too low message and continue with the specified SeqNum
KeepConnectionState (optional)
Boolean
UseAsyncConnect (optional)
Boolean
DisableTCPBuffer (optional)
Boolean true - TCP buffer (Nagle algorithm) will be disabled for the session
SocketRecvBufSize (optional)
Integer
SocketSendBufSize (optional)
Integer
SocketBusyPollTime (optional)
Integer
StorageType (optional)
String
StorageRecoveryStrategy (optional)
String
MaxMessagesAmountInBunch (optional)
Integer
SocketPriority (optional)
String
AggressiveReceiveDelay (optional)
This property must be either an non-negative integer or <code>null</code>.
EnableAutoSwitchToBackupConnection (optional)
Boolean true - enabled automatic mode switch. Default: false
CyclicSwitchBackupConnection (optional)
Boolean Enable connection probing loop between primary and backup connections until connection will be established.
HandleSeqNumAtLogon (optional)
Boolean Handle sequence gaps using NextExpectedMsgSeqNum.
ReconnectMaxTries (optional)
Integer
ReconnectInterval (optional)
Integer
ConnectAddress (optional)
String
ConnectPort (optional)
Integer
MessagesStorageSize (optional)
This property must be either an non-negative integer or <code>null</code>.
AllowMessageWithoutPossDupFlag (optional)
Boolean true - Message with low SeqNum and without PossDupFlag(43) will trigger the connection close. false - message will be processed.
SuppressDoubleResendRequest (optional)
Boolean Suppress ResendRequest on every incoming message when SeqNum is too high
DeliverAppMessagesOutOfOrder (optional)
Boolean Forces session to deliver messages if SeqNum is too high. Requested by CME.
SendLastMsgSeqNumProcessed (optional)
Boolean
ValidateCheckSum (optional)
Boolean
GenerateCheckSum (optional)
Boolean
LogIncomingMessages (optional)
Boolean
ResendRequestBlockSize (optional)
Integer
Transport (optional)
String
UseBlockingSockets (optional)
Boolean Useful for OpenOnload.
CpuAffinity (optional)
Integer
SendCpuAffinity (optional)
Integer
LogonMessageSessionQualifierTag (optional)
Integer
RawDataTagProcessingStrategies (optional)
String
Validation (optional)
ValidationParameters

SessionParams Up

ActiveConnection (optional)
SessionActiveConnection
Backup (optional)
SessionBackupParameters
ConfiguredName (optional)
String
ConnectTime (optional)
String
DisconnectTime (optional)
String
ExtraParams (optional)
SessionExtraParameters
HBI (optional)
Integer
InSeqNum (optional)
Integer
OutSeqNUm (optional)
Integer
RecreateOnLogout (optional)
Boolean
RemoteHost (optional)
String
RemotePort (optional)
Integer
Schedule (optional)
String
StartTime (optional)
String
StorageType (optional)
String
TerminateOnLogout (optional)
Boolean
TerminateTime (optional)
String
AppProtocolBaseVersion (optional)
String
CustomLogon (optional)
String
DefaultApplicationProtocol (optional)
String
Protocol (optional)
UnderlyingProtocol
Role (optional)
SessionRole
SSL (optional)
String
SSLCheckPrivateKey (optional)
String
SSLCertificate (optional)
String
SSLPrivateKey (optional)
String
SSLProtocols (optional)
String
Version (optional)
String
IncomingMessagesLimit (optional)
Integer
OutgoingQueueSizeLimit (optional)
Integer
IncomingThroughputLimit (optional)
Integer
AsyncProcessing (optional)
Boolean
AsyncProcessingQueueSizeLimit (optional)
Integer

SessionRole - Role of a session Up

SessionSequenceNumbers Up

InSeqNum (optional)
Integer
OutSeqNum (optional)
Integer

SessionState - State of a session Up

<p>Possible states of Session.</p> <ul> <li>ESTABLISHED - The session is fully established <li>INITIAL - The session has been created, but has not been connected yet <li>NON_GRACEFULLY_TERMINATED - The session has been non-gracefully terminated <li>RECONNECT - The session-initiator has detected the telecommunication link error and is trying to re-establish the link <li>CORRECTLY_TERMINATED - The session has been correctly terminated <li>WAIT_FOR_CONFIRM_LOGON - The session has been connected as an Initiator, the first Logon message has been sent and it is waiting for the conforming Logon message <li>WAIT_FOR_CONFIRM_LOGOUT - Waiting for confirm logout state <li>WAIT_FOR_FIRST_LOGON - The session has been connected as an Acceptor and is waiting for the first Logon message <li>SWITCH_CONNECTION - The session switch to the another connection (backup or primary) <li>WAIT_FOR_FIRST_HELLO - The session has been connected as an Acceptor and is waiting for the first Hello message <li>WAIT_FOR_CONFIRM_HELLO - The session has been connected as an Initiator, the first FAST Hello message has been sent and it is waiting for the conforming Hello message <li>WAIT_FOR_CONNECT - The session-initiator is waiting fo async connect to complete </ul>

SessionStatistics Up

SenderCompID (optional)
String
TargetCompID (optional)
String
Qualifier (optional)
String
ReceivedMessages (optional)
Integer
SentMessages (optional)
Integer
IncomingThroughput (optional)
Integer
CurrentProcessingQueueSize (optional)
Integer

SessionStatus Up

ConfiguredName (optional)
String
SenderCompID (optional)
String
TargetCompID (optional)
String
Qualifier (optional)
String
AppProtocolBaseVersion (optional)
String
Status (optional)
SessionState
ActiveConnection (optional)
SessionActiveConnection
InSeqNum (optional)
Integer
OutSeqNum (optional)
Integer
SessionCreated (optional)
Boolean

SessionStatusesEvent Up

data
array[SessionStatus] List of sessions' metrics

SessionUpdatableParams Up

ActiveConnection (optional)
SessionActiveConnection
Backup (optional)
SessionBackupParameters
ConfiguredName (optional)
String
ConnectTime (optional)
String
DisconnectTime (optional)
String
ExtraParams (optional)
SessionExtraParameters
HBI (optional)
Integer
InSeqNum (optional)
Integer
OutSeqNUm (optional)
Integer
RecreateOnLogout (optional)
Boolean
RemoteHost (optional)
String
RemotePort (optional)
Integer
Schedule (optional)
String
StartTime (optional)
String
StorageType (optional)
String
TerminateOnLogout (optional)
Boolean
TerminateTime (optional)
String

SessionsDataEvent Up

event
String Event type (get, create, change state, delete)
data
array[SessionData] List of fix sessions

StatusGroup Up

UnderlyingProtocol Up

Set of the supported underlying protocols

ValidationParameters Up

IsEnabled (optional)
Boolean
ProhibitTagsWithoutValue (optional)
Boolean false: Messages empty tags will be ignored. Otherwise exception will be thrown
VerifyTagsValues (optional)
Boolean false: Counterparty validates the messages by itself
ProhibitUnknownTags (optional)
Boolean false: The engine will reject messages with unknown fields. true: The engine will store the message as it is.
VerifyRepeatingGroupBounds (optional)
Boolean true: The check is performed by server. false: Message will be passed to the application layer as is and the counterparty is responsible for its validity.
CheckRequiredGroupFields (optional)
Boolean true: The check is performed by server. false: The check is performed by counterparty.
AllowZeroNumInGroup (optional)
Boolean true: accept. false: reject
ProhibitDuplicatedTags (optional)
Boolean true: Reject messages with duplicated field definitions. false: Accept such messages
IgnoreUnknownFields (optional)
Boolean