GET v1/Portfolios/{id}/CompositeLink

Description

Retrieve a composites for Portfolio with WSO ID of {id}.

Base Url

https://api-zion.wsohosting.com/


Rest Call Syntax


GET Reference/v1/Portfolios/{id}/CompositeLink

GET Reference/v1/Portfolios/{id}/CompositeLink

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 Portfolio

integer

Required

IsMember

Check whether the composite is linked with parent id or not.

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer




Response Information



PagedList Of CompositeInfo

Name

Description

Type

Additional Information

Items

Collection of CompositeInfo

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "compositeId": 1,
      "compositeName": "sample string 2",
      "isMember": true
    },
    {
      "compositeId": 1,
      "compositeName": "sample string 2",
      "isMember": true
    }
  ],
  "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:
<PagedListOfCompositeInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <CompositeInfo>
      <CompositeId>1</CompositeId>
      <CompositeName>sample string 2</CompositeName>
      <IsMember>true</IsMember>
    </CompositeInfo>
    <CompositeInfo>
      <CompositeId>1</CompositeId>
      <CompositeName>sample string 2</CompositeName>
      <IsMember>true</IsMember>
    </CompositeInfo>
  </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>
</PagedListOfCompositeInfo>



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.