Messages : 28 Status Message : 28.2 Status Message Structure
 
28.2 Status Message Structure
 
Table 20: Status Message Structure  
Attribute
Type
Definition
ClearCache
boolean
An indication that any previous last value payload data cache for the event stream needs to be deleted. If absent, ClearCache defaults to false.
Domain
string,int
Specifies the domain model represented by this message. If absent, Domain defaults to MarketPrice.
Click here for a list of available values
Analytics
Contribution
Dictionary
EconomicIndicator
Forecast
History
Headline
Login
MarketByOrder
MarketByPrice
MarketByTime
MarketMaker
MarketPrice
NewsTextAnalytics
Poll
ProviderAdmin
ServiceProviderStatus
Source
Story
SymbolList
System
Reference
ReplayHeadline
ReplayStory
Transaction
YieldCurve
ExtHdr
string
An optional extension to the request message in case an attribute is identified that currently doesn’t fit into the request message header.
ID
int
Required. Integer value representing the event stream. It can also be used to match the request and responses.
Key
object
The key representing the data content or requested capability.
Elements
object
An Element List describing additional attributes of the item stream.
Filter
object
A filter specification used to request which filter entries will be present in a Filter List payload.
Identifier
int
A user-defined numeric identifier. Identifier is defined on a per-domain basis. This attribute's range is from -2,147,483,648 to 2,147,483,647.
Name
string,array(string)
Name(s) of the information requested.
NameType
string,int
An enumeration representing the different forms the name can take. If absent, NameType defaults to Ric.
Click here for a list of available values
AuthnToken: Authentication Token
Cookie: User information is specified in cookie
EmailAddress: Email Address
Name: Username
Ric: Reuters Instrument Code
Token: User Token (Typically AAA Token)
Unspecified: Unspecified
Service
string,int
A name or ID representing the identifier of the service provider. If absent, Service defaults to the default service in the Refinitiv Real-Time Advanced Distribution Server configuration.
PermData
string
Contains permission authorization information for all content provided on this stream.
PostUserInfo
object
Represents information about the posting user.
Address
string
Required. Dotted-decimal string representing the IP Address of the posting user.
UserID
int
Required. Specifies the ID of the posting user.
Private
boolean
Private stream. If absent, Private defaults to false.
State
object
Conveys information about the health of the stream.
Code
string,int
Additional status information for the event stream or data state. Not needed for generic state processing.
Click here for a list of possible Code values
AlreadyOpen: Indicates that a stream is already open on the connection for the requested data.
AppAuthorizationFailed: Indicates that application authorization using the secure token has failed.
DacsDown: Indicates that the connection to Data Access Control System is down and users are not allowed to connect.
Error: Indicates an internal error from the sender.
ExceededMaxMountsPerUser: Indicates that the login was rejected because the user exceeded their maximum number of allowed mounts.
FailoverCompleted: Indicated that recovery from a failover condition has finished.
FailoverStarted: Indicates that the component is recovering due to a failover condition. User is notified when recovery finishes via FailoverCompleted.
FullViewProvided: Indicates that the full view (e.g., all available fields) is being provided, even though only a specific view was requested.
GapDetected: Indicates that a gap was detected between messages.
GapFill: Indicates that the received content is meant to fill a recognized gap.
InvalidArgument: Indicates that the request includes an invalid or unrecognized parameter. Specific information should be contained in Text.
InvalidView: Indicates that the requested view is invalid, possibly due to bad formatting. Additional information should be available in Text.
JitConflationStarted: Indicates that JIT conflation has started on the stream. User is notified when JIT conflation ends via RealtimeResume.
MaxLoginsReached: Indicates that the maximum number of logins has been reached.
NoBatchViewSupportInReq: Indicates that the provider does not support batch and/or view functionality.
None: Indicates that additional state code information is not required, nor present.
NonUpdatingItem: Indicates that a streaming request was made for non-updating data.
NoResources: Indicates that no resources are available to accommodate the stream.
NotEntitled: Indicates that the request was denied due to permissioning. Typically indicates that the requesting user does not have permission to request on the service, to receive requested data, or to receive data at the requested Quality of Service.
NotFound: Indicates that requested information was not found, though it might be available at a later time or through changing some parameters used in the request.
NotOpen: Indicates that the stream was not opened. Additional information should be available in Text.
Preempted: Indicates the stream was preempted, possibly by caching device. Typically indicates the user has exceeded an item limit, whether specific to the user or a component in the system. Relevant information should be contained in Text.
RealtimeResumed: Indicated that JIT conflation on the stream has finished.
SourceUnknown: Indicates that the requested service is not known, though the service might be available at a later point in time.
Timeout: Indicates that the timeout occurred somewhere in the system while processing requested data.
Code
(continued)
string,int
(continued)
TooManyItems: Indicates that a request cannot be processed because too many other streams are already open.
UnableToRequestAsBatch: Indicates that a batch request cannot be used for this request. The user can instead split the batched items into individual requests.
UnsupportedViewType: Indicates that the domain on which a request is made does not support the requests ViewType.
UsageError: Indicates invalid usage within the system. Specific information should be contained in Text.
UserAccessToAppDenied: Indicates that the application is denied access to the system.
UserUnknownToPermSys: Indicates that the user is unknown to the permissioning system and is not allowed to connect.
Data
string,int
Represents the quality of the data in the response or in the event stream.
Click here for a list of available data qualities
NoChange: There is not change in the current state of the data.
Ok: All data associated with the stream is healthy and current.
Suspect: Some or all of the data on a stream is out-of-date (or that it cannot be confirmed as current, e.g., the service is down). If an application does not allow suspect data, a stream might change from Open to Closed or ClosedRecover as a result.
Stream
string,int
The state of the event stream when using the request/response with interest paradigm.
Click here for a list of available stream states
Closed: Data is not available on this service and connection is not likely to become available, though the data might be available on another service or connection.
ClosedRecover: State is closed, however data can be recovered on this service and connection at a later time.
NonStreaming: The stream is closed and updated data is not delivered without a subsequent re-request.
Open: Data is streaming, as data changes it is sent to the stream.
Redirected: The current stream is closed and has new identifying information. The user can issue a new request for the data using the new message key data from the redirect message.
Text
string
Specifies additional information about the current state.
Type
string,int
Required. Specifies the message classification. For Status messages, Type is Status.
Click here for a list of available types
Ack
Close
Generic
Post
Refresh
Request
Status
Update
Qualified
boolean
Qualified stream. If absent, Qualified defaults to false.