GET v1/Equities/{id}/Dividends/{dividendId}

Description

Retrieve a rating with WSO ID of {dividendId} for equity with a WSO ID of {id}.

Base Url

https://api-agc.wsohosting.com/


Rest Call Syntax


GET SecurityMaster/v1/Equities/{id}/Dividends/{dividendId}

GET SecurityMaster/v1/Equities/{id}/Dividends/{dividendId}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

dividendId

WSO ID of dividend

integer

Required

id

WSO ID of Equity

integer

Required




Response Information



Dividend

Name

Description

Type

Additional Information

Amount

The dividend amount in shares or cash

decimal number

AssetId

The WSO ID of the asset

integer

DeclaredDate

The day on which a corporation announces the dividend

date

DestinationId

The WSO ID of the asset disbursed as a dividend

integer

DestinationTypeId

The asset type of a dividend disbursement by ID value

integer

DividendName

The dividend name/description

string

DividendTypeId

The dividend type by ID value: 1 = cash; 2 = stock

ExDividendDate

The date a stock trades without dividends

date

Id

The WSO ID of the dividend item

integer

Links

The Hateoas links to dividend operations

Collection of Link

PayableDate

The date the dividend payment is sent

date

RecordDate

The date on which you must be the owner of record in order to receive the dividend payment

date




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "dividendName": "sample string 2",
  "amount": 3.1,
  "assetId": 4,
  "declaredDate": "2024-10-08T05:37:37.1701085-05:00",
  "destinationId": 1,
  "destinationTypeId": 1,
  "dividendTypeId": "Cash",
  "exDividendDate": "2024-10-08T05:37:37.1701085-05:00",
  "payableDate": "2024-10-08T05:37:37.1701085-05:00",
  "recordDate": "2024-10-08T05:37:37.1701085-05:00",
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample:
<Dividend xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>3.1</Amount>
  <AssetId>4</AssetId>
  <DeclaredDate>2024-10-08T05:37:37.1701085-05:00</DeclaredDate>
  <DestinationId>1</DestinationId>
  <DestinationTypeId>1</DestinationTypeId>
  <DividendName>sample string 2</DividendName>
  <DividendTypeId>Cash</DividendTypeId>
  <ExDividendDate>2024-10-08T05:37:37.1701085-05:00</ExDividendDate>
  <Id>1</Id>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <PayableDate>2024-10-08T05:37:37.1701085-05:00</PayableDate>
  <RecordDate>2024-10-08T05:37:37.1701085-05:00</RecordDate>
</Dividend>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.