|
IHS Markit API |
PUT v1/Bonds/{id}/CouponSchedule/{couponId}
Description
Update a single coupon schedule item with an ID of {couponID} for a bond with a WSO ID of {id}. Updating the date for this {couponID} will also update the end date of the previous coupon and the start date of the next coupon.
Base Url
https://api-sim.uat.wsohosting.com/
Rest Call Syntax
PUT SecurityMaster/v1/Bonds/{id}/CouponSchedule/{couponId}
PUT SecurityMaster/v1/Bonds/{id}/CouponSchedule/{couponId}
Name
Description
Type
Additional Information
CouponDate
The date of the coupon payment
date
Coupon Date can neither be before the interest accrual date nor after the maturity date
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
couponId
WSO ID of coupon
integer
Required
id
WSO ID of bond
integer
Required
Request body formats
application/json, text/json
{
"couponDate": "2024-10-08T05:40:44.5233112-05:00"
}
application/xml, text/xml
<CouponUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CouponDate>2024-10-08T05:40:44.5233112-05:00</CouponDate> </CouponUpdate>
application/x-www-form-urlencoded
Sample not available.
Response Information
BondCoupon
Name
Description
Type
Additional Information
AddDate
Gets or sets the date that the coupon was created.
date
AddId
Gets or sets the name of the user who added the coupon.
string
AddNode
Gets or sets the name of the machine that added the coupon.
string
CouponDate
The date of the coupon payment
date
Id
The WSO ID of the coupon rate schedule item
integer
LastChangeDate
Gets or sets the date of the last change to the coupon.
date
LastChangeId
Gets or sets the name of the user that last made changes to the coupon.
string
LastChangeNode
Gets or sets the name of the machine that last made changes to the coupon.
string
StartDate
The date of the prior coupon
date
Response Body Formats
application/json, text/json
{
"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"
}
],
"id": 3,
"couponDate": "2024-10-08T05:40:44.5233112-05:00",
"startDate": "2024-10-08T05:40:44.5233112-05:00",
"addId": "sample string 6",
"addNode": "sample string 7",
"addDate": "2024-10-08T05:40:44.5233112-05:00",
"lastChangeId": "sample string 9",
"lastChangeNode": "sample string 10",
"lastChangeDate": "2024-10-08T05:40:44.5233112-05:00"
}
application/xml, text/xml
<BondCoupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AddDate>2024-10-08T05:40:44.5233112-05:00</AddDate>
<AddId>sample string 6</AddId>
<AddNode>sample string 7</AddNode>
<CouponDate>2024-10-08T05:40:44.5233112-05:00</CouponDate>
<Id>3</Id>
<LastChangeDate>2024-10-08T05:40:44.5233112-05:00</LastChangeDate>
<LastChangeId>sample string 9</LastChangeId>
<LastChangeNode>sample string 10</LastChangeNode>
<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>
<StartDate>2024-10-08T05:40:44.5233112-05:00</StartDate>
</BondCoupon>