GET v1/CDS/{id}/CouponSchedule

Description

Retrieve coupon schedule for CDS with a WSO ID of {id}.

Base Url

https://services.wsoweb.com/

Rest Call Syntax


GET SecurityMaster/v1/CDS/{id}/CouponSchedule

Execute API

GET SecurityMaster/v1/CDS/{id}/CouponSchedule

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

Coupon search criteria

integer

Required

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer



Response Information


Paged List of Coupons


PagedList Of CdsCoupon

Name

Description

Type

Additional Information

Items

Collection of CdsCoupon

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "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-11-23T01:31:14.9074808-06:00",
      "startDate": "2024-11-23T01:31:14.9074808-06:00",
      "addId": "sample string 6",
      "addNode": "sample string 7",
      "addDate": "2024-11-23T01:31:14.9074808-06:00",
      "lastChangeId": "sample string 9",
      "lastChangeNode": "sample string 10",
      "lastChangeDate": "2024-11-23T01:31:14.9074808-06: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"
        }
      ],
      "id": 3,
      "couponDate": "2024-11-23T01:31:14.9074808-06:00",
      "startDate": "2024-11-23T01:31:14.9074808-06:00",
      "addId": "sample string 6",
      "addNode": "sample string 7",
      "addDate": "2024-11-23T01:31:14.9074808-06:00",
      "lastChangeId": "sample string 9",
      "lastChangeNode": "sample string 10",
      "lastChangeDate": "2024-11-23T01:31:14.9074808-06:00"
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "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: 
<PagedListOfCdsCoupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <CdsCoupon>
      <AddDate>2024-11-23T01:31:14.9074808-06:00</AddDate>
      <AddId>sample string 6</AddId>
      <AddNode>sample string 7</AddNode>
      <CouponDate>2024-11-23T01:31:14.9074808-06:00</CouponDate>
      <Id>3</Id>
      <LastChangeDate>2024-11-23T01:31:14.9074808-06: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-11-23T01:31:14.9074808-06:00</StartDate>
    </CdsCoupon>
    <CdsCoupon>
      <AddDate>2024-11-23T01:31:14.9074808-06:00</AddDate>
      <AddId>sample string 6</AddId>
      <AddNode>sample string 7</AddNode>
      <CouponDate>2024-11-23T01:31:14.9074808-06:00</CouponDate>
      <Id>3</Id>
      <LastChangeDate>2024-11-23T01:31:14.9074808-06: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-11-23T01:31:14.9074808-06:00</StartDate>
    </CdsCoupon>
  </Items>
  <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>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfCdsCoupon>


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.