Hello @kostix and all,

Please find the information on this content provided in response to your question by RDP News product team (some of this information is planned to be made available via API Playground as part of the Reference Guide):

payloadVersion can be specified in the subscription syntax when it do the subscription

{
   "transport": {
"transportType": "AWS-SQS"
        },
   "filter": {             …
}
"payloadVersion": "1.0" or "2.0" 
}

• Default value is 2.0, so if user don’t specify the option it will be 2.0

Then in the alert pushed to user queue, it contains the payloadVersion and the payload. For 2.0 it looks like this {
    "data": {
      "attributes": [        {          "domain": {            "type": "string",            "value": "headline"          }        }
      ],
      "envelopeVersion": "1.0",
      "ecpMessageID": "urn:newsml:reuters.com:20171030:nTOPLAT:57705",
      "sourceSeqNo": 1127927,
      "distributionSeqNo": 1,
      "sourceTimestamp": "2021-04-09T04:40:33.000Z",
      "distributionTimestamp": "2021-04-09T04:40:45.883Z",
      "payloadVersion": "2.0",
      "subscriptionID": "551bc6ba-1991-42ab-9c17-39c4ed009e9f",
      "payload": {
"newsItem": [ ]         } } 

• For 1.0 it looks like this

{
    "data": {
      "attributes": [        {          "domain": {            "type": "string",            "value": "headline"          }        }
      ],
      "envelopeVersion": "1.0",
      "ecpMessageID": "urn:newsml:reuters.com:20171030:nTOPLAT:57705",
      "sourceSeqNo": 1127927,
      "distributionSeqNo": 1,
      "sourceTimestamp": "2021-04-09T04:40:33.000Z",
      "distributionTimestamp": "2021-04-09T04:40:45.883Z",
      "payloadVersion": "1.0",
      "subscriptionID": "551bc6ba-1991-42ab-9c17-39c4ed009e9f",
      "payload": {
        "newsMessage": {             "header": { …}             "itemSet": {
                    "newsItem": [ ]               } } 

• The key difference between 1.0 and 2.0 is about the “payload”, for 1.0 it includes the newsMessage which contains the header and 2.0 just output the newsItem without the header. The reason why we cut over from 1.0 to 2.0 is to align with request/response and RSF header should be invisible to end user.
• By saying that default 2.0 is expected as we don’t want to diverge streaming alerts with R/R anymore.

Hello @kostix,

As neither RDP News User and Design Guide nor Alerts Reference Guide on API Playground describe submitting payloadVersion as part of the request, I believe that it is not intended to be submitted.

Further, the deployed versions of the service on API Playground are beta1 and v1. Therefore, I would suppose that the default version returned 1.0 is the latest released, and v 2.0 is the next, not made available yet.

In RDP News User and Design Guide I find the description of "Payload Version" but no provided means for the request to drive the selection of it. The version provided is intended, in my understanding, to be selected by the service, as the latest released.

I would not recommend submitting payloadVersion parameter as part of the request.

However, I will try to verify with the product team, if there is any additional information, that can be made available.

@zoya.farberov, thanks for the explanation!

Can I refine my question a bit more?

Do we have to expect that the newsItem element (with either payloadVersion value) may contain more than a single element? If yes, what are the semantics of this with regard to the fact a single news alert pushed to an AWS SQS queue (or returned in a single R&R API exchange) ostensibly contains a single news story (for instance, see [1])?

In other words, can a single news story contain multiple "news items"? If yes, what whould be the meaning of this — having multiple news items per a single news story? What would be the meaning of the term "item" then?

Or should I ask a separate question for this?

And while we're at it, in our testing environment we observe that subscribing to news story alerts using RDP without specifying payloadVersion would send us pieces formatted using payloadVersion 1.0, not 2.0. That is, the defaults appear to be different — at least in the testing environment.

1. https://community.developers.refinitiv.com/answers/75990/view.html

Hello @kostix,

Per RDP News User and Design Guide:

"4.4.2. Item Set In EDP Item Set is one of the following:

 News Item (newsItem): A simple item of type Text.

 Package Item (packageItem): A set of News Items item references to other items and/or resources. ..."

: either single newsItem or multiple packaged newsItems.

It is indeed better to ask a separate question as a new question next time, it allows this question for better visibility and searchability, while including a link(s) to the previous related question(s) correlates any relevant discussions and content.

From my testing, as of now, payloadVersion is 1.0

"itemSet": {
  "newsItem": [
    {
      "_conformance": ...,
      "_guid": ...,
      ...
    }
	]
}

Hello @kostix,

I think this basic definition stems from IPTC NewsML-G2 Guidelines.

It is, in a general case, possible to have "the child elements of <itemSet> be any number of <newsItem>, <packageItem>, <conceptItem>, and/or <knowledgeItem> components, in any combination, in any order.".

At present, per RDP News, either one newsItem or one packagedItem. But as NewsML spec allows for mulitples, the spec is being observed in the structure definition.

I am going to convert these comments to answers, to allow for the visibility of this information.

Hello @kostix,

Please find further clarification from the product team:

"

a/ RSF is based on the external G2 standard; G2 supports a newsMessage with a contentSet; the contentSet supports 1..N items.

b/ RSF follows the above, but for product reasons only supports a contentSet with 1..N [newsItem or packageItem ]

c/ Currently our text items only have a single newsItem per newsMessage, so that (correctly) looks like a newsItem array with a single entry.

d/ The item array is to allow for other potential product groupings which may be needed in the future - e.g. Reuters has a ‘package’ which has a packageItem + 1..N newsItems.

---

payloadVersion 1.0 (to be deprecated): both is array, no matter if there is only 1 element in the array newsItem[] and packageItem[]

payloadVersion 2.0 : only newsItem[0] returned as an Object. For packageItem inside the contentSet

We are to return the “only” one object to payload 2.0 to align with Request/Response.

{

"data": {

"attributes": [ { "domain": { "type": "string", "value": "headline" } }

],

"envelopeVersion": "1.0",

"ecpMessageID": "urn:newsml:reuters.com:20171030:nTOPLAT:57705",

"sourceSeqNo": 1127927,

"distributionSeqNo": 1,

"sourceTimestamp": "2021-04-09T04:40:33.000Z",

"distributionTimestamp": "2021-04-09T04:40:45.883Z",

"payloadVersion": "2.0",

"subscriptionID": "551bc6ba-1991-42ab-9c17-39c4ed009e9f",

"payload": {

"newsItem": {}
}
}

"

I hope this information is of help