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

Description

Retrieve a single coupon schedule item with WSO ID of {couponID} for a cds with a WSO ID of {id}.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


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

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

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

couponId

WSO ID of coupon

integer

Required

id

WSO ID of cds

integer

Required




Response Information



CdsCoupon

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

Links

A list of hateoas links

Collection of Link

StartDate

The date of the prior coupon

date




Response Body Formats



application/json, text/json

Sample:
{
  "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:35:07.1687125-06:00",
  "startDate": "2024-11-23T01:35:07.1687125-06:00",
  "addId": "sample string 6",
  "addNode": "sample string 7",
  "addDate": "2024-11-23T01:35:07.1687125-06:00",
  "lastChangeId": "sample string 9",
  "lastChangeNode": "sample string 10",
  "lastChangeDate": "2024-11-23T01:35:07.1687125-06:00"
}

application/xml, text/xml

Sample:
<CdsCoupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddDate>2024-11-23T01:35:07.1687125-06:00</AddDate>
  <AddId>sample string 6</AddId>
  <AddNode>sample string 7</AddNode>
  <CouponDate>2024-11-23T01:35:07.1687125-06:00</CouponDate>
  <Id>3</Id>
  <LastChangeDate>2024-11-23T01:35:07.1687125-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:35:07.1687125-06:00</StartDate>
</CdsCoupon>



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.