GET v1/Composites/{id}

Description

Retrieve Composites with Composite ID of {id}.

Base Url

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


Rest Call Syntax


GET Reference/v1/Composites/{id}

GET Reference/v1/Composites/{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

Composite ID

integer

Required

IsDeleted

This flag will allow the return of deleted Composites in the search results

PortfolioFilterType

This value will allow to filter portfolio based on supplied portfolio type.




Response Information



CompositeItem

Name

Description

Type

Additional Information

CompositeAbbrevName

The abbreviated name of the composite.

string

CompositeName

The name of the composite.

string

Id

The unique ID for this composite.

integer

IsDeleted

Has this composite been deleted?

boolean

IsFund

Is Fund.

boolean

Links

The Hateoas links to related object

Collection of Link

Notes

Notes.

string




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "isDeleted": true,
  "compositeName": "sample string 3",
  "compositeAbbrevName": "sample string 4",
  "notes": "sample string 5",
  "isFund": 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"
    }
  ]
}

application/xml, text/xml

Sample:
<CompositeItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CompositeAbbrevName>sample string 4</CompositeAbbrevName>
  <CompositeName>sample string 3</CompositeName>
  <Id>1</Id>
  <IsDeleted>true</IsDeleted>
  <IsFund>true</IsFund>
  <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>
  <Notes>sample string 5</Notes>
</CompositeItem>



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.