Please reframe/correct the below API query to get the correct results

nikhil.ms
nikhil.ms LSEG
edited March 4 in DSS

Hi Team,

I am using https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/ExtractWithNotes

to fetch the standard coporate action data, the api is wroking fine when using delta query, but for init query my payload is failing

Please find the details:

{

"ExtractionRequest": {

"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.CorporateActionsStandardExtractionRequest",

"ContentFieldNames": [

"Accounting Standard"

],

"IdentifierList": {

"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",

"InstrumentIdentifiers": [

{

"IdentifierType": "ArgentineAfipCode"

}

],

"ValidationOptions": {

"AllowOpenAccessInstruments": true,

"AllowHistoricalInstruments": true,

"AllowLimitedTermInstruments": true,

"AllowInactiveInstruments": true,

"AllowUnsupportedInstruments": true,

"ExcludeFinrAsPricingSourceForBonds": true,

"UseExchangeCodeInsteadOfLipper": true,

"UseUsQuoteInsteadOfCanadian": true,

"UseConsolidatedQuoteSourceForUsa": true,

"UseConsolidatedQuoteSourceForCanada": true,

"UseDebtOverEquity": true,

"UseOtcPqSource": true,

"AllowSubclassImport": true

},

"UseUserPreferencesForValidationOptions": true

},

"Condition": {

"ReportDateRangeType": "Init",

"IncludeInstrumentsWithNoEvents": true,

"IncludeNullDates": true,

"ExcludeDeletedEvents": true,

"IncludeCapitalChangeEvents": true,

"IncludeDividendEvents": true,

"IncludeEarningsEvents": true,

"IncludeMergersAndAcquisitionsEvents": true,

"IncludeNominalValueEvents": true,

"IncludePublicEquityOfferingsEvents": true,

"IncludeSharesOutstandingEvents": true,

"IncludeVotingRightsEvents": true,

"CorporateActionsCapitalChangeType": "CapitalChangeAnnouncementDate",

"CorporateActionsDividendsType": "DividendAnnouncementDate",

"CorporateActionsEarningsType": "EarningsAnnouncementDate",

"CorporateActionsEquityOfferingsType": "AllPendingDeals",

"CorporateActionsMergersAcquisitionsType": "DealAnnouncementDate",

"CorporateActionsNominalValueType": "NominalValueDate",

"CorporateActionsSharesType": "SharesAmountDate",

"CorporateActionsStandardEventsType": "CAP",

"CorporateActionsVotingRightsType": "VotingRightsDate",

"ShareAmountChoice": "All",

"ShareAmountTypes": [

"Authorised"

],

"LastEntityOnly": true

}

}

}

Getting the error on postman app:

{

"error": {

"message": "Validation Errors:ReportDateRangeType of \"Init\" is not valid for this report template type.\r\n\r\nSelectedItemCode \"COR-STND.DtRange.INIT\" is not a valid SelectedItemCode for selection type \"COR-STND.DtRange\".\r\nRawValue \"INIT\" is invalid for selection type \"COR-STND.DtRange\".\r\nCannot set UseUserPreferencesForValidationOptions and also set ValidationOptions on the InstrumentIdentifierList"

}

}

Used this link for reference- https://selectapi.datascope.refinitiv.com/RestApi.Help/Context/Operation?ctx=Extractions&opn=ExtractWithNotes&grp=On%20Demand%20Extraction

Could you please check and let me know the right parameters to be passed in paylaod for 'init' query

Answers

  • Hello @nikhil.ms

    There are two errors in your query.

    You should specify:

    "UseUserPreferencesForValidationOptions": false
    

    if you would like to specify your own ValidationOptions in the JSON request message.

    Second message states that Init is not a valid date option - even though it is shown as one of the options for this particular API.

    image.png

    For this issue, I would recommend that you reach out to content experts by opening a ticket at LSEG MyAccount.

  • Jirapongse
    Jirapongse ✭✭✭✭✭

    @nikhil.ms

    You may check the Corporate Actions - Stardard Events Report template on the DSS Web UI for the supported ReportDateRangeType. According to the DSS Web UI, it supports Range, Delta, and Last.

    image.png

    You can refer to the REST API Tutorial 5: On Demand corporate actions extraction tutorial for the sample request.