Create a session capabilities subscription

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  ContextId	String	Body	The streaming context id that this request is associated with. This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters.
  Format	String	Body	Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client. Currently only application/json and application/x-protobuf is supported. If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format.
  ReferenceId	String	Body	Mandatory client specified reference id for the subscription. This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters.
  RefreshRate	Integer	Body	Optional custom refresh rate, measured in milliseconds, between each data update. Note that it is not possible to get a refresh rate lower than the rate specified in the customer service level agreement (SLA).
  ReplaceReferenceId	String	Body	Reference id of the subscription that should be replaced.
  Tag	String	Body	Optional client specified tag used for grouping subscriptions.

• Response Parameters

  View Response Codes

  Name	Type	Description
  ContextId	String	The streaming context id that this response is associated with.
  Format	String	The media type (RFC 2046), of the serialized data updates that are streamed to the client.
  InactivityTimeout	Integer	The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid.
  ReferenceId	String	The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type)
  RefreshRate	Integer	Actual refresh rate assigned to the subscription according to the customers SLA.
  Snapshot	SessionSubscriptionStreamedState	Snapshot of the current data on hand, when subscription was created.
  State	String	This property is kept for backwards compatibility.
  Tag	String	Client specified tag assigned to the subscription, if specified in the request.

  HTTP Code	Description
  201	Created	Created
  400	Bad Request	Error Code Description InvalidModelState Error code returned when model state is invalid. UnsupportedSubscriptionFormat Error code returned when a subscription format that isn't supported by the publisher is requested.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  409	Conflict	Error Code Description SubscriptionLimitExceeded Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Streaming Response Parameters

  Name	Type	Description
  AuthenticationLevel	AuthenticationLevel	Gets or sets the authentication level.
  DataLevel	DataLevel	Gets or sets the data L evel.
  TradeLevel	TradeLevel	Gets or sets the trade level.

• Request Example

  Request URL

  POST /root/v1/sessions/events/subscriptions

  Request Body

  {
    "ContextId": "20241214060721923",
    "ReferenceId": "S19163",
    "RefreshRate": 1000,
    "Tag": "PAGE1"
  }
  

• Response Example

  Response body

  {
    "ContextId": "20241214060721923",
    "Format": "application/json",
    "InactivityTimeout": 120,
    "ReferenceId": "S19163",
    "RefreshRate": 1000,
    "Snapshot": {
      "AuthenticationLevel": "Authenticated",
      "DataLevel": "Standard",
      "TradeLevel": "OrdersOnly"
    },
    "State": "Active"
  }
  

• Streaming Response Example

  Response body

  {
    "AuthenticationLevel": "Authenticated",
    "DataLevel": "Standard",
    "TradeLevel": "FullTradingAndChat"
  }