For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
abhishek.joshi6 avatar image
1 ●2 ●2 ●1

Information required for request response structure of Corporate Actions ISO report refinitiv api call.

Hi Team,

We need to consume refinitiv's Corporate Actions ISO report api call and require json request structure for making this call. Also, please provide the details of what will be the output format/structure of this call. Example: Currently we are consuming refinitiv eod price api call using below request structure:

{

"ExtractionRequest":{

"@odata.type":"#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.EndOfDayPricingExtractionRequest",

"ContentFieldNames":[

"ISIN",

"RIC",

"User Defined Identifier",

"Universal Ask Price",

"Universal Bid Ask Date",

"Universal Bid Price",

"Universal Close Price",

"Universal Close Price Date",

"Accrual",

"Accrued Interest",

"Alternate Close Grade",

"Alternate Close Price",

"Ask Clean Price",

"Ask Dirty Price",

"Ask Price",

"Asset Status",

"Asset Status Description",

"Base Currency Code",

"Bid Clean Price",

"Bid Dirty Price",

"Bid Price",

"Close Price",

"Close Price Timestamp",

"Close Price Timestamp Grade",

"Currency Code",

"Currency Code Description",

"Currency Code Scaled",

"Currency Code Scaled Description",

"Exchange Code",

"Exchange Description"

],

"IdentifierList":{

"@odata.type":"#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",

"InstrumentIdentifiers":[

{

"Identifier":"AT0000A100E2",

"IdentifierType":"Isin",

"Source":"TWE"

},

{

"Identifier":"AT0000A100E2",

"IdentifierType":"Isin",

"Source":"EJV"

}

],

"ValidationOptions":null,

"UseUserPreferencesForValidationOptions":false

},

"Condition":{

"ScalableCurrency":true

}

}

}

Can you please help us provide similar request structure of Corporate Actions ISO report call?


Thanks and Regards,

Abhishek Joshi

dss-rest-apidatascope-selectdsscorporate-actions
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

2 Answers

Upvotes
Accepted
veerapath.rungruengrayubkul avatar image
11.3k ●25 ●8 ●14

Hi @abhishek.joshi6,

The Corporate Actions ISO 15022 can be retrieved on CorporateActionsISO report template. The report template support only the ExtractRaw endpoint. You can find the instruction for ExtractRaw on this tutorial.

Below is the sample of request body provided in the API Reference Tree and C# Example Application which is available on the download tab.

You can find more details about data in the ISO 15022 Service User Guide.

POST https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractRaw
{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.CorporateActionsIsoExtractionRequest",
        "Condition": {
            "ReportDateRangeType": "Init",
            "ReportIsoEvents": [
                "ACTV",
                "BIDS"
            ],
            "IncludeNonPendingEvents": true,
            "GrossAmountOnlyForPaymentEvents": true,
            "ExcludeNilPaidFromPaymentEvents": true
        },
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "IBM.N",
                    "IdentifierType": "Ric"
                }
            ],
            "ValidationOptions": null,
            "UseUserPreferencesForValidationOptions": false
        }
    }
}


icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

abhishek.joshi6 avatar image abhishek.joshi6

Hi @veerapath.rungruengrayubkul , thanks for the response, we were able to hit the corporate action api, but as mentioned in the tutorial link we are being returned a job id and we need to make another api call to extract actual CA data (https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/RawExtractionResults('0x0730bbbce486becc')/$value). Isin being used in the request are FR0000031122 and DE0008404005 (but getting blank response for both). Can you please also let us know the Content-Type to be put in header of this request. Currently we are trying with "application/json", but not getting any response (We get 200 OK status but response is blank). Can you please suggest what should be done here?


Thanks and Regards,

Abhishek Joshi

Upvotes
veerapath.rungruengrayubkul avatar image
11.3k ●25 ●8 ●14

Hi @abhishek.joshi6,

I have tried to add all ReportIsoEvents in the request and am able to get some response, so this likely is related to the content. You can contact DSS content support via MyRefinitiv for further discussion. Below is the request.

{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.CorporateActionsIsoExtractionRequest",
        "Condition": {
            "ReportDateRangeType": "Init",
            "ReportIsoEvents": [
                "ACTV", "BIDS", "BONU", "BPUT", "BRUP", "CAPD", "CAPG", "CAPI", "CHAN", "CMET", "CONV", "DECR", "DFLT", "DLST", "DRCA", "DRIP",
                "DVCA", "DVOP", "DVSE", "EXOF", "EXRI", "EXTM", "EXWA", "INCR", "INTR", "LIQU", "MCAL", "MEET", "MRGR", "ODLT", "OMET", "OTHR",
                "PARI", "PCAL", "PPMT", "PRIO", "REDM", "REDO", "RHDI", "RHTS", "SHPR", "SOFF", "SPLF", "SPLR", "SUSP", "TEND", "XMET"

            ],
            "IncludeNonPendingEvents": true,
            "GrossAmountOnlyForPaymentEvents": true,
            "ExcludeNilPaidFromPaymentEvents": true
        },
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "FR0000031122",
                    "IdentifierType": "Isin"
                },
                {
                    "Identifier": "DE0008404005",
                    "IdentifierType": "Isin"
                }
            ],
            "ValidationOptions": null,
            "UseUserPreferencesForValidationOptions": false
        }
    }
}

Anyway, you can also find some useful informationin the Notes in the response of ExtractRaw request. Below is sample of the Notes information.

{     "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#RawExtractionResults/$entity",     
"JobId": "0x0730cae61286bee9",     
"Notes": [         
"...Processing completed successfully at 30/07/2020 09:10:43, taking 2.41 Secs.
Extraction finished at 30/07/2020 02:10:43 UTC, with servers: x02A05, QSHC20 (1.7 secs), QSSHA1 (0.0 secs)
Column 'CIN' suppressed for lack of CIN permission.
Column 'CapitalChangeNewSecurityCin' suppressed for lack of CIN permission.
Column 'IsoRightsSecurityCin' suppressed for lack of CIN permission.
1 Corporate Action ISO message was generated.
..."     
] }
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.