Store projected dividends for equities.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"use_best_effort": true,
"dividends": [
{
"$type": "Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": false,
"asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"reference_date": "2023-11-07T05:31:56Z",
"all_in_rate": 123,
"cash_dividend": 123,
"confirmed": true,
"currency": "<string>",
"declared_date": "2023-11-07T05:31:56Z",
"dividend_yield": 123,
"ex_date": "2023-11-07T05:31:56Z",
"pay_date": "2023-11-07T05:31:56Z",
"record_date": "2023-11-07T05:31:56Z",
"index_component_asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"withholding_tax_rate": 123
}
]
}
'import requests
url = "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends"
payload = {
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"use_best_effort": True,
"dividends": [
{
"$type": "Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": False,
"asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"reference_date": "2023-11-07T05:31:56Z",
"all_in_rate": 123,
"cash_dividend": 123,
"confirmed": True,
"currency": "<string>",
"declared_date": "2023-11-07T05:31:56Z",
"dividend_yield": 123,
"ex_date": "2023-11-07T05:31:56Z",
"pay_date": "2023-11-07T05:31:56Z",
"record_date": "2023-11-07T05:31:56Z",
"index_component_asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"withholding_tax_rate": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core',
market_data_environment_name: 'Example market data',
provider_id: '<string>',
use_best_effort: true,
dividends: [
{
$type: 'Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core',
provider_id: '<string>',
derivitec_created: '<string>',
derivitec_modified: '<string>',
uploaded_date_time: '<string>',
derivitec_modified_by: '<string>',
uploaded_by: '<string>',
rolled: false,
asset_id: {
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
},
reference_date: '2023-11-07T05:31:56Z',
all_in_rate: 123,
cash_dividend: 123,
confirmed: true,
currency: '<string>',
declared_date: '2023-11-07T05:31:56Z',
dividend_yield: 123,
ex_date: '2023-11-07T05:31:56Z',
pay_date: '2023-11-07T05:31:56Z',
record_date: '2023-11-07T05:31:56Z',
index_component_asset_id: {
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
},
withholding_tax_rate: 123
}
]
})
};
fetch('https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core',
'market_data_environment_name' => 'Example market data',
'provider_id' => '<string>',
'use_best_effort' => true,
'dividends' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core',
'provider_id' => '<string>',
'derivitec_created' => '<string>',
'derivitec_modified' => '<string>',
'uploaded_date_time' => '<string>',
'derivitec_modified_by' => '<string>',
'uploaded_by' => '<string>',
'rolled' => false,
'asset_id' => [
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
],
'reference_date' => '2023-11-07T05:31:56Z',
'all_in_rate' => 123,
'cash_dividend' => 123,
'confirmed' => true,
'currency' => '<string>',
'declared_date' => '2023-11-07T05:31:56Z',
'dividend_yield' => 123,
'ex_date' => '2023-11-07T05:31:56Z',
'pay_date' => '2023-11-07T05:31:56Z',
'record_date' => '2023-11-07T05:31:56Z',
'index_component_asset_id' => [
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
],
'withholding_tax_rate' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
]
}Store projected dividends for equities.
Use this operation to replace a projected dividend schedule for each equity and reference date in a
non-default provider that the caller may edit. Ex-dates must be on or after the date-only reference date,
AllInRate must be between -1 and 1, and DividendType accepts Regular,
Extraordinary, or Scrip. UseBestEffort defaults to false; when true, valid equity/date
groups can be stored despite rejected rows or identifiers. Processing completes before the response is returned.
POST
/
api
/
MarketData
/
UploadProjectedDividends
Store projected dividends for equities.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"use_best_effort": true,
"dividends": [
{
"$type": "Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": false,
"asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"reference_date": "2023-11-07T05:31:56Z",
"all_in_rate": 123,
"cash_dividend": 123,
"confirmed": true,
"currency": "<string>",
"declared_date": "2023-11-07T05:31:56Z",
"dividend_yield": 123,
"ex_date": "2023-11-07T05:31:56Z",
"pay_date": "2023-11-07T05:31:56Z",
"record_date": "2023-11-07T05:31:56Z",
"index_component_asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"withholding_tax_rate": 123
}
]
}
'import requests
url = "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends"
payload = {
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"use_best_effort": True,
"dividends": [
{
"$type": "Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": False,
"asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"reference_date": "2023-11-07T05:31:56Z",
"all_in_rate": 123,
"cash_dividend": 123,
"confirmed": True,
"currency": "<string>",
"declared_date": "2023-11-07T05:31:56Z",
"dividend_yield": 123,
"ex_date": "2023-11-07T05:31:56Z",
"pay_date": "2023-11-07T05:31:56Z",
"record_date": "2023-11-07T05:31:56Z",
"index_component_asset_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
},
"withholding_tax_rate": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core',
market_data_environment_name: 'Example market data',
provider_id: '<string>',
use_best_effort: true,
dividends: [
{
$type: 'Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core',
provider_id: '<string>',
derivitec_created: '<string>',
derivitec_modified: '<string>',
uploaded_date_time: '<string>',
derivitec_modified_by: '<string>',
uploaded_by: '<string>',
rolled: false,
asset_id: {
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
},
reference_date: '2023-11-07T05:31:56Z',
all_in_rate: 123,
cash_dividend: 123,
confirmed: true,
currency: '<string>',
declared_date: '2023-11-07T05:31:56Z',
dividend_yield: 123,
ex_date: '2023-11-07T05:31:56Z',
pay_date: '2023-11-07T05:31:56Z',
record_date: '2023-11-07T05:31:56Z',
index_component_asset_id: {
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
},
withholding_tax_rate: 123
}
]
})
};
fetch('https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core',
'market_data_environment_name' => 'Example market data',
'provider_id' => '<string>',
'use_best_effort' => true,
'dividends' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core',
'provider_id' => '<string>',
'derivitec_created' => '<string>',
'derivitec_modified' => '<string>',
'uploaded_date_time' => '<string>',
'derivitec_modified_by' => '<string>',
'uploaded_by' => '<string>',
'rolled' => false,
'asset_id' => [
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
],
'reference_date' => '2023-11-07T05:31:56Z',
'all_in_rate' => 123,
'cash_dividend' => 123,
'confirmed' => true,
'currency' => '<string>',
'declared_date' => '2023-11-07T05:31:56Z',
'dividend_yield' => 123,
'ex_date' => '2023-11-07T05:31:56Z',
'pay_date' => '2023-11-07T05:31:56Z',
'record_date' => '2023-11-07T05:31:56Z',
'index_component_asset_id' => [
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
],
'withholding_tax_rate' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/MarketData/UploadProjectedDividends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"use_best_effort\": true,\n \"dividends\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.Dividend, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"derivitec_created\": \"<string>\",\n \"derivitec_modified\": \"<string>\",\n \"uploaded_date_time\": \"<string>\",\n \"derivitec_modified_by\": \"<string>\",\n \"uploaded_by\": \"<string>\",\n \"rolled\": false,\n \"asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"reference_date\": \"2023-11-07T05:31:56Z\",\n \"all_in_rate\": 123,\n \"cash_dividend\": 123,\n \"confirmed\": true,\n \"currency\": \"<string>\",\n \"declared_date\": \"2023-11-07T05:31:56Z\",\n \"dividend_yield\": 123,\n \"ex_date\": \"2023-11-07T05:31:56Z\",\n \"pay_date\": \"2023-11-07T05:31:56Z\",\n \"record_date\": \"2023-11-07T05:31:56Z\",\n \"index_component_asset_id\": {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n },\n \"withholding_tax_rate\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
]
}Authorizations
oauth2apikey
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. Dividends must be non-empty; each row supplies an equity identifier, reference and event dates, cash, yield, rate, tax, currency, confirmation, dividend type, and optional index-component identifier.
Submits projected dividend schedules.
Available options:
Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsRequest, Derivitec.Web.Core Name of the market-data environment to use. Supply either this name or provider_id, not both.
Example:
"Example market data"
Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.
Requests independent handling of input records when one cannot be processed; defaults to false.
Projected dividend schedules to upload.
Show child attributes
Show child attributes
Response
Returns whether the projected dividends were stored and validation or unsupported-identifier errors.
Returns the success flag and error messages from a projected-dividend upload.
Available options:
Derivitec.Web.Core.MarketData.ApiUploadProjectedDividendsResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
Example:
true
Messages explaining operation-level failures. The collection is empty by default.
Was this page helpful?