|
IHS Markit API |
PUT v1/Facilities/{id}/FacilityRateOptions/{facilityRateOptionId}
Description
Update rate option with WSO ID of {facilityRateOptionId} for facility with WSO ID of {id}.
Base Url
https://services.wsoweb.com/
Rest Call Syntax
PUT SecurityMaster/v1/Facilities/{id}/FacilityRateOptions/{facilityRateOptionId}
PUT SecurityMaster/v1/Facilities/{id}/FacilityRateOptions/{facilityRateOptionId}
Name
Description
Type
Additional Information
AALSpread
The AAL spread of the facility option.
decimal number
DateOffset
The number of days it takes to receive current rates from the issuing entity
integer
FirstPaymentDate
The first payment date of a contract with this rate option
date
Frequency
The payment frequency listed as total number of payments in one year - i.e. Quarterly = 4
integer
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this facility option.
boolean
SkimInterestEnabled
SkimInterest feature of facility option.
boolean
Spread
The spread rate
decimal number
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
facilityRateOptionId
WSO ID of rate option
integer
Required
id
WSO ID of facility
integer
Required
Request body formats
application/json, text/json
{
"dateOffset": 1,
"firstPaymentDate": "2024-11-23T01:20:15.4394258-06:00",
"frequency": 2,
"monthCount": "ACT",
"yearCount": "ACT",
"spread": 3.1,
"isBaseRateObservationShiftEnabled": true,
"baseRateInterestMethod": "Unassigned",
"baseRateCompoundMethod": "Unassigned",
"skimInterestEnabled": true,
"aalSpread": 6.1
}
application/xml, text/xml
<FacilityRateOptionUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AALSpread>6.1</AALSpread> <BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod> <BaseRateInterestMethod>Unassigned</BaseRateInterestMethod> <DateOffset>1</DateOffset> <FirstPaymentDate>2024-11-23T01:20:15.4394258-06:00</FirstPaymentDate> <Frequency>2</Frequency> <IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled> <MonthCount>ACT</MonthCount> <SkimInterestEnabled>true</SkimInterestEnabled> <Spread>3.1</Spread> <YearCount>ACT</YearCount> </FacilityRateOptionUpdate>
application/x-www-form-urlencoded
Sample not available.
Response Information
FacilityRateOption
Name
Description
Type
Additional Information
AALSpread
The AAL spread of the facility option.
decimal number
BaseRateRoundingPrecision
The precision to which the base rate should be rounded.
decimal number
DateOffset
The number of days to offset the Effective Date passed to GetBaseRate.
integer
FirstPay
The default first payment date of this facility option.
date
Frequency
The default payment frequency associated with this facility option (4 for quarterly, 12 for monthly).
integer
Id
The id of the Facility Option. This is for internal use only
integer
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this facility option.
boolean
IsBaseRateRoundingEnabled
A flag indicating whether or not base rate rounding is enabled for this facility option.
boolean
RateOptionName
The name of the facility option.
string
SkimInterestEnabled
SkimInterest feature of facility option.
boolean
Spread
The spread, rate, or fee rate of the facility option.
decimal number
Response Body Formats
application/json, text/json
{
"dateOffset": 1,
"id": 3,
"rateOptionName": "sample string 4",
"firstPay": "2024-11-23T01:20:15.5107316-06:00",
"frequency": 5,
"monthCount": "ACT",
"yearCount": "ACT",
"spread": 6.1,
"behavior": "LIBOR",
"isBaseRateRoundingEnabled": true,
"baseRateRoundingPrecision": 8.1,
"baseRateRoundingDirection": "None",
"isBaseRateObservationShiftEnabled": true,
"baseRateInterestMethod": "Unassigned",
"baseRateCompoundMethod": "Unassigned",
"skimInterestEnabled": true,
"aalSpread": 11.1,
"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
<FacilityRateOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AALSpread>11.1</AALSpread>
<BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod>
<BaseRateInterestMethod>Unassigned</BaseRateInterestMethod>
<BaseRateRoundingDirection>None</BaseRateRoundingDirection>
<BaseRateRoundingPrecision>8.1</BaseRateRoundingPrecision>
<Behavior>LIBOR</Behavior>
<DateOffset>1</DateOffset>
<FirstPay>2024-11-23T01:20:15.5107316-06:00</FirstPay>
<Frequency>5</Frequency>
<Id>3</Id>
<IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled>
<IsBaseRateRoundingEnabled>true</IsBaseRateRoundingEnabled>
<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>
<MonthCount>ACT</MonthCount>
<RateOptionName>sample string 4</RateOptionName>
<SkimInterestEnabled>true</SkimInterestEnabled>
<Spread>6.1</Spread>
<YearCount>ACT</YearCount>
</FacilityRateOption>