GET v1/Facilities/{id}/SpreadHistory/{spreadHistoryId}

Description

Retrieve a single spread history item with WSO ID of {spreadHistoryId} for facility with a WSO ID of {id}.

Base Url

https://api-sim.uat.wsohosting.com/


Rest Call Syntax


GET SecurityMaster/v1/Facilities/{id}/SpreadHistory/{spreadHistoryId}

GET SecurityMaster/v1/Facilities/{id}/SpreadHistory/{spreadHistoryId}

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 facility

integer

Required

spreadHistoryId

WSO ID of facility spread history item

integer

Required




Response Information



SpreadHistory

Name

Description

Type

Additional Information

EndDate

The end date of the spread history range

date

FacilitySpreadName

A description of the spread

string

Id

The WSO ID for this object

integer

Links

A list of relevant links

Collection of Link

Spread

The value of the spread

decimal number

StartDate

The start date of the spread history range

date




Response Body Formats



application/json, text/json

Sample:
{
  "endDate": "2024-10-08T05:37:15.7624012-05:00",
  "id": 4,
  "facilitySpreadName": "sample string 5",
  "spread": 6.1,
  "startDate": "2024-10-08T05:37:15.7624012-05: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"
    }
  ]
}

application/xml, text/xml

Sample:
<SpreadHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.API.SecurityMaster.Models.v1">
  <EndDate>2024-10-08T05:37:15.7624012-05:00</EndDate>
  <FacilitySpreadName>sample string 5</FacilitySpreadName>
  <Id>4</Id>
  <Links>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <Spread>6.1</Spread>
  <StartDate>2024-10-08T05:37:15.7624012-05:00</StartDate>
</SpreadHistory>



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.