Messages : 26 Refresh Message : 26.2 Refresh Message Structure
 
26.2 Refresh Message Structure
 
Table 18: Refresh 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 true.
Complete
boolean
Indicates that the payload data in the response is complete. Some domain models require a single response with payload data; others allow multi-part responses of payload data that will have this flag set in the last message. If absent, Complete defaults to true.
Domain
string,int
Specifies the domain model represented by this message. If absent, Domain defaults to MarketPrice.
Click here for a list of available domains
Analytics
Contribution
Dictionary
EconomicIndicator
Forecast
Headline
History
Login
MarketByOrder
MarketByPrice
MarketByTime
MarketMaker
MarketPrice
NewsTextAnalytics
Poll
ProviderAdmin
Reference
ReplayHeadline
ReplayStory
ServiceProviderStatus
Source
Story
SymbolList
System
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.
PartNumber
int
Specifies the part number of the message when part of a multi-part refresh. 0 indicates the message is the first part of the multi-part refresh. Each subsequent part increments PartNumber by 1. This attribute's range is 0 to 32767.
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.
Qos
object
Specifies the Quality of Service. Provides classification of data/events to provide different tiers of service.
Click here for a list of available values:
When specified on the originating request without a WorstQos member, Qos is the only Quality of Service for the stream (if the Quality of Service is unavailable, the stream is not opened).
When specified with a WorstQos on the originating request, Qos is the best in the range of allowable Quality of Services. When a Quality of Service range is specified, any Quality of Service within the range is acceptable for servicing the stream.
Absence of both Qos nor WorstQos in the originating request indicates that any available Quality of Service will satisfy the request.
Some components may require Qos on the initial request and reissue messages. For details, refer to specific component documentation.
Dynamic
boolean
Specifies whether or not Qos is dynamic. If absent, KeyInUpdates defaults to false.
Rate
string,int
Required. Maximum period of change in data (for streaming events).
Click here for a list of available values:
JitConflated: Just-in-time conflated, meaning that quality is typically tick-by-tick, but if burst data occurs (or if a component cannot keep up with tick-by-tick delivery), multiple updates are combined into a single update to reduce traffic. This value is usually considered a lower quality than TickByTick.
TickByTick: Tick-by-Tick, meaning data is sent for every update. This is the highest quality of rate value. The best overall Quality of Service is a Rate of TickByTick and a Timeliness of Realtime.
TimeConflated: The interval of time (usually in milliseconds) over which data are conflated is provided in RateInfo. This is a lower quality than TickByTick and at times even lower than JitConflated.
RateInfo
int
Specifies any information related to Rate.
TimeInfo
int
Information related to Timeliness.
Timeliness
string,int
Required. Specifies the data’s age.
Click here for a list of available values
Delayed: Timeliness is delayed and the amount of delay is provided in TimeInfo. This is lower quality than Realtime and might be better than DelayedUnknown.
DelayedUnknown: Timeliness is delayed, although the amount of delay is unknown. This is a lower quality than Realtime and might be worse than Delayed (in which case the delay is known).
Realtime: Data is updated as soon as new data is available, and is the highest-quality Timeliness value. In conjunction with a Rate of TickByTick, Realtime is the best overall Quality of Service.
SeqNumber
int
Sequence number intended to help with temporal ordering. Typically, this will be incremented with every message, but may have gaps depending on the sequencing algorithm being used.
Solicited
boolean
Indicates whether the message is a solicited response to a request or an unsolicited response to an existing event stream. If absent, Solicited defaults to true.
State
object
Required. 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 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 the 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.
None: Indicates that additional state code information is not required, nor present.
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.
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.
NoBatchViewSupportInReq: Indicates that the provider does not support batch and/or view functionality.
NonUpdatingItem: Indicates that a streaming request was made for non-updating data.
NoResources: Indicates that no resources are available to accommodate the stream.
NotOpen: Indicates that the stream was not opened. Additional information should be available 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.
Code
(Continued)
string,int
(Continued)
Timeout: Indicates that the timeout occurred somewhere in the system while processing requested data.
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.
UserAccessToAppDenied: Indicates that the application is denied access to the system.
UsageError: Indicates invalid usage within the system. Specific information should be contained in Text.
UserUnknownToPermSys: Indicates that the user is unknown to the permissioning system and is not allowed to connect.
Data
string,int
Required. 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
Required. 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 Refresh messages, Type is Refresh.
Click here for a list of available types
Ack
Close
Generic
Post
Refresh
Request
Status
Update