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

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
hiroko.goto avatar image
5 ●1 ●2 ●5

Difference between "UseUserPreferencesForValidationOptions" and "ValidationOptions

What is difference between DSS API options "UseUserPreferencesForValidationOptions" and "ValidationOptions"?

These two seem to be the same, but please advise how different they are.

example:

"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": false

Regards,

Hiroko

dss-rest-apidatascope-selectdss
icon clock
10 |1500

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

1 Answer

Upvotes
Accepted
Christiaan Meihsl avatar image
13.7k ●26 ●8 ●12

@hiroko.goto,

Both these settings can be set in a data extraction request, to change the system behavior for that specific request. The purpose it to override the defaults defined in the general preferences set in the GUI.

ValidationOptions

Sets individual options. Each one of these overrides the equivalent setting defined in the general preferences.

"UseUserPreferencesForValidationOptions": false

Disables all user preferences. The behavior reverts to the default, but with all the overrides defined using ValidationOptions.

Please also note that the settings in the general preferences set in the GUI only apply to scheduled extractions, not On Demand extractions, which systematically use defaults. Hence the fact that these 2 parameters are often used in On Demand extractions, the most common use case being to retrieving data for historical instruments, by setting:

"ValidationOptions": { "AllowHistoricalInstruments": true },"UseUserPreferencesForValidationOptions": false

Hope this clarifies.

icon clock
10 |1500

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

Click below to post an Idea Post Idea