GET v1/ABS/{id}

Description

Retrieve an ABS with WSO ID of {id}.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


GET SecurityMaster/v1/ABS/{id}

GET SecurityMaster/v1/ABS/{id}

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

id

WSO ID of ABS

integer

Required




Response Information



Abs

Name

Description

Type

Additional Information

AssetBackedSecurityName

The name of the asset in WSO which typically includes the coupon rate and maturity date

string

AssetClassId

The class of the asset set by the user

integer

Attributables

Link to ABS Attributables

BaseRateCompoundMethod

The CompoundMethod

BaseRateInterestMethod

The InterestMethod

Collateral

The description of the collateral that is backing the asset

string

CountryId

The legal country for this asset by ID value

integer

CouponDateOffset

Business Day Offset - this determines when a coupon should pay if the coupon date falls on a non-business day

CouponFrequency

The Coupon Frequency indicates how many times a year there is a coupon payment

CouponRates

The Hateoas link to get all coupon rate schedules for the bond

Coupons

The Hateoas link to get all coupon schedules for the bond

CouponType

The Coupon Type of the asset

CurrencyCode

The currency type for this ABS by ID value

string

DataFeedId

The external data import source for this asset by ID value

integer

DateOffset

Given the type of coupon - this is the number of days to offset the coupon rate

integer

DayCount

The Day Count convention for the asset

DefaultDate

The date that the asset went into default status

date

DefaultType

The type of default that has occurred on the asset

string

FirstCouponDate

The first coupon payment date for the asset

date

FirstSettleDate

The first settle date listed for the asset

date

FixedRate

The fixed coupon rate

decimal number

GuarantorId

The guarantor for the asset by ID value

integer

HasAttachedWarrants

The flag indicating if the asset has attached warrants

boolean

HasDefaulted

The flag indicating if the asset has defaulted

boolean

HasFXRisk

The flag indicating if the asset has foreign exchange risk

boolean

HolidayCalendarId

The holiday calendar for the asset by ID value

integer

Id

The WSO ID for the asset

integer

Identifiers

Link to Identifiers

InsurerId

The insurer of the asset by ID value

integer

InterestAccrualDate

The first date that the asset starts accruing interest

date

IsBaseRateObservationShiftEnabled

Gets or sets a flag indicating whether or not base rate observation shift is enabled for this ABS asset.

boolean

IsDeleted

A flag indicating if the ABS asset is soft-deleted in the system

boolean

IsEmergingMarket

The flag indicating if the ABS asset is from an emerging market

boolean

IsInterestOnly

The flag indicating if this is an interest only asset

boolean

IsMostSeniorTranche

The flag indicating if the asset is the most senior tranche

boolean

IsPrincipalOnly

The flag indicating if this is a principal only asset

boolean

IsPrivate

The flag indicating if this is a private security

boolean

IsRestructured

The flag indicating if the security has been restructured since it was initially issued

boolean

IsStructuredFinanceObligation

The flag indicating if the asset belongs to a structured finance obligation

boolean

Issue

The issue description of the asset

string

IssueDate

The date that the asset was officially issued

date

IssuePrice

The original price at which the asset was issued

decimal number

Issuer

A link to retrieve the Issuer

IssueSize

The original global amount of the asset at issuance

decimal number

IsSynthetic

The flag indicating if this a synthetic security

boolean

IsTradedAccrued

The flag indicating if the asset trades with accrued interest

boolean

LeadUnderwriterId

The lead underwriting bank of the asset by ID value

integer

Links

The Hateoas links related to this entity

Collection of Link

LockoutDays

integer

MaturityDate

The maturity date of the asset

date

MaturityDateExpected

The expected maturity date of the asset - optional field

date

Notes

The notes regarding the asset

string

OriginalCapPercentage

The original capitalized percentage of the asset

decimal number

PayNonBusinessDirection

Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay

PayOffsetDays

Pay Offset - the number of days that coupon payment occurs differing from the coupon date

integer

PayOffsetDirection

Pay Offset - the number of days for the payment offset

PayOffsetType

Pay Offset - the type of days to count: business or actual

PaysEndOfMonth

The flag indicating if this asset pays end of month when the first coupon date does not fall on the 31st

boolean

RateOptionId

The rate option for the asset

integer

Ratings

Link to Ratings

RegistrationType

The registration type

string

SeniorityId

The seniority level of the ABS asset by ID value

integer

SpreadRate

The spread rate of the ABS asset

decimal number

TransferAgentId

The agent responsible for issuing certificates listed by ID value

integer

Udfs

Link to Udfs




Response Body Formats



application/json, text/json

Sample:
{
  "couponRates": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "coupons": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "id": 1,
  "assetBackedSecurityName": "sample string 2",
  "assetClassId": 1,
  "collateral": "sample string 3",
  "countryId": 1,
  "currencyCode": "sample string 4",
  "couponDateOffset": "None",
  "couponFrequency": "Annual",
  "couponType": "Fixed",
  "dataFeedId": 1,
  "dateOffset": 1,
  "dayCount": "ACT_ACT",
  "defaultDate": "2024-11-23T01:25:12.5153902-06:00",
  "defaultType": "sample string 5",
  "firstCouponDate": "2024-11-23T01:25:12.5153902-06:00",
  "firstSettleDate": "2024-11-23T01:25:12.5153902-06:00",
  "fixedRate": 1.1,
  "guarantorId": 1,
  "hasAttachedWarrants": true,
  "hasFXRisk": true,
  "holidayCalendarId": 1,
  "insurerId": 1,
  "interestAccrualDate": "2024-11-23T01:25:12.5153902-06:00",
  "hasDefaulted": true,
  "isEmergingMarket": true,
  "isInterestOnly": true,
  "isMostSeniorTranche": true,
  "isPrincipalOnly": true,
  "isPrivate": true,
  "isBaseRateObservationShiftEnabled": true,
  "isRestructured": true,
  "isStructuredFinanceObligation": true,
  "issue": "sample string 19",
  "issueDate": "2024-11-23T01:25:12.5153902-06:00",
  "issuePrice": 1.1,
  "issuer": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "issueSize": 1.0,
  "isSynthetic": true,
  "isTradedAccrued": true,
  "leadUnderwriterId": 1,
  "lockoutDays": 22,
  "maturityDate": "2024-11-23T01:25:12.5153902-06:00",
  "maturityDateExpected": "2024-11-23T01:25:12.5153902-06:00",
  "notes": "sample string 25",
  "originalCapPercentage": 26.1,
  "payNonBusinessDirection": "On",
  "payOffsetDays": 27,
  "payOffsetDirection": "After",
  "payOffsetType": "BusinessDays",
  "paysEndOfMonth": true,
  "rateOptionId": 1,
  "registrationType": "sample string 29",
  "seniorityId": 1,
  "spreadRate": 1.1,
  "transferAgentId": 1,
  "isDeleted": true,
  "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"
    }
  ],
  "attributables": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "identifiers": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "ratings": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "udfs": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "baseRateInterestMethod": "Unassigned",
  "baseRateCompoundMethod": "Unassigned"
}

application/xml, text/xml

Sample:
<Abs xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssetBackedSecurityName>sample string 2</AssetBackedSecurityName>
  <AssetClassId>1</AssetClassId>
  <Attributables>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Attributables>
  <BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod>
  <BaseRateInterestMethod>Unassigned</BaseRateInterestMethod>
  <Collateral>sample string 3</Collateral>
  <CountryId>1</CountryId>
  <CouponDateOffset>None</CouponDateOffset>
  <CouponFrequency>Annual</CouponFrequency>
  <CouponRates>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </CouponRates>
  <CouponType>Fixed</CouponType>
  <Coupons>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Coupons>
  <CurrencyCode>sample string 4</CurrencyCode>
  <DataFeedId>1</DataFeedId>
  <DateOffset>1</DateOffset>
  <DayCount>ACT_ACT</DayCount>
  <DefaultDate>2024-11-23T01:25:12.5153902-06:00</DefaultDate>
  <DefaultType>sample string 5</DefaultType>
  <FirstCouponDate>2024-11-23T01:25:12.5153902-06:00</FirstCouponDate>
  <FirstSettleDate>2024-11-23T01:25:12.5153902-06:00</FirstSettleDate>
  <FixedRate>1.1</FixedRate>
  <GuarantorId>1</GuarantorId>
  <HasAttachedWarrants>true</HasAttachedWarrants>
  <HasDefaulted>true</HasDefaulted>
  <HasFXRisk>true</HasFXRisk>
  <HolidayCalendarId>1</HolidayCalendarId>
  <Id>1</Id>
  <Identifiers>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Identifiers>
  <InsurerId>1</InsurerId>
  <InterestAccrualDate>2024-11-23T01:25:12.5153902-06:00</InterestAccrualDate>
  <IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled>
  <IsDeleted>true</IsDeleted>
  <IsEmergingMarket>true</IsEmergingMarket>
  <IsInterestOnly>true</IsInterestOnly>
  <IsMostSeniorTranche>true</IsMostSeniorTranche>
  <IsPrincipalOnly>true</IsPrincipalOnly>
  <IsPrivate>true</IsPrivate>
  <IsRestructured>true</IsRestructured>
  <IsStructuredFinanceObligation>true</IsStructuredFinanceObligation>
  <IsSynthetic>true</IsSynthetic>
  <IsTradedAccrued>true</IsTradedAccrued>
  <Issue>sample string 19</Issue>
  <IssueDate>2024-11-23T01:25:12.5153902-06:00</IssueDate>
  <IssuePrice>1.1</IssuePrice>
  <IssueSize>1</IssueSize>
  <Issuer>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Issuer>
  <LeadUnderwriterId>1</LeadUnderwriterId>
  <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>
  <LockoutDays>22</LockoutDays>
  <MaturityDate>2024-11-23T01:25:12.5153902-06:00</MaturityDate>
  <MaturityDateExpected>2024-11-23T01:25:12.5153902-06:00</MaturityDateExpected>
  <Notes>sample string 25</Notes>
  <OriginalCapPercentage>26.1</OriginalCapPercentage>
  <PayNonBusinessDirection>On</PayNonBusinessDirection>
  <PayOffsetDays>27</PayOffsetDays>
  <PayOffsetDirection>After</PayOffsetDirection>
  <PayOffsetType>BusinessDays</PayOffsetType>
  <PaysEndOfMonth>true</PaysEndOfMonth>
  <RateOptionId>1</RateOptionId>
  <Ratings>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Ratings>
  <RegistrationType>sample string 29</RegistrationType>
  <SeniorityId>1</SeniorityId>
  <SpreadRate>1.1</SpreadRate>
  <TransferAgentId>1</TransferAgentId>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
</Abs>



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.