verifyRICS (SOAP) implementation on REST API (TRTHv2)

ricardo.siguero

Hi,

We are migrating from SOAP API to REST API (TRTHv2) and we'd like to know how to get the same functionality of the verifyRICs method (SOAP) on the new REST API:

import com.thomsonreuters.tickhistory.webservice.TRTHApi;

...

private TRTHApi api;

...

VerifyRICsResult result =  api.verifyRICs(range, new ArrayOfInstrument(instrumentList), true);

Thanks in advance

Christiaan Meihsl

@ricardo.siguero, as far as I know there is no equivalent API call, but there are different possibilities for verifying RICs:

1) To verify the current validity of a RIC, you can search for it, using a POST to endpoint Search/InstrumentSearch.

Body:

{
  "SearchRequest": {
    "IdentifierType": "Ric",
    "Identifier": "CARR.PA",
    "PreferredIdentifierType": "Ric"
  }
}

If the instrument is currently valid you will receive something like:

{
    "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#Collection(ThomsonReuters.Dss.Api.Content.ValidatedInstrument)",
    "value": [
        {
            "Identifier": "CARR.PA",
            "IdentifierType": "Ric",
            "Source": "PAR",
            "Key": "VjF8MHgwMDAzZGQwMDE0Yjg0ZTNjfDB4MDAwM2RjMDA0YzFjYWYyMHxQQVJ8RVFRVXxFUVRZfE9EU0h8RXx8Q0FSUi5QQXwwMDUy",
            "Description": "CARREFOUR ORD",
            "InstrumentType": "EquityQuote",
            "Status": "Valid"
        }
    ]
}

If it is invalid, the returned field value will be empty. More on this call in REST API Tutorial 16.

2) To verify the historical validity of a RIC, you can use endpoint Search/HistoricalSearch.

Body (contains the date range where you want to check validity):

{
  "Request": {
    "Identifier": "CARR.PA",
    "IdentifierType": "Ric",
    "Range": {
      "Start": "2017-01-01T00:00:00.000Z",
      "End": "2017-01-01T00:00:00.000Z"
    }
  }
}

More on historical search in REST API Tutorial 13.

3) If you append instruments to an instrument list, the response will tell you how many are valid, and deliver error messages for those that are not, like:

"Messages": [
    {
        "Severity": "Info",
@ (not found)"
    }
]

More on this in REST API Tutorial 12.

Edit: added possibility:

4) Perform a validation on a set of instruments, using endpoint Extractions/InstrumentListValidateIdentifiers.

Body (only the first instrument is valid in this example):

{
  "InputsForValidation": [
    {
      "Identifier": "191216100",
      "IdentifierType": "Cusip"
    },{
      "Identifier": "JUNK.RIC",
      "IdentifierType": "Ric"
    },{
      "Identifier": "INVALID",
      "IdentifierType": "Ric"
    }
  ],
  "KeepDuplicates": false
}

Result:

{
    "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#ThomsonReuters.Dss.Api.Extractions.SubjectLists.InstrumentsValidateIdentifiersResult",
    "ValidatedInstruments": [
        {
            "Identifier": "191216100",
            "IdentifierType": "Cusip",
            "Source": "NYS",
            "Key": "VjF8MHgwMDAzZGQwMDE0ZjkxODJifDB4MDAwM2RjMDA0YTA0NjlmOHxOWVN8RVFRVXxFUVRZfE9EU0h8RXx8S08uTnwwMDc3",
            "Description": "COCA-COLA ORD",
            "InstrumentType": "EquityQuote",
            "Status": "Valid"
        }
    ],
    "ValidationResult": {
        "ValidInstrumentCount": 1,
        "OpenAccessSegments": [],
        "StandardSegments": [
            {
                "Code": "E",
                "Description": "Equity",
                "Count": 1
            }
        ],
        "ValidationDuplicates": [],
        "Messages": [
            {
                "Severity": "Info",
                "Message": "RIC, JUNK.RIC (not found)"
            },
            {
                "Severity": "Info",
                "Message": "RIC, INVALID (not found)"
            }
        ]
    }
}

Hope this helps