GET v1/Positions

Description

Retrive list of positions satisfying the input search criteria.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


GET PositionManagement/v1/Positions

GET PositionManagement/v1/Positions

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

AssetId

integer

IdentifierType

Identifier Type to search

string

IdentifierValue

Identifier Value to search

string

IssuerId

integer

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioId

integer




Response Information



PagedList Of PositionListItem

Name

Description

Type

Additional Information

Items

Collection of PositionListItem

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "positionName": "sample string 2",
      "accountingCategoryId": 1,
      "administratorId": 1,
      "allowDirtyPricing": true,
      "accretionDate": "2024-11-22T10:15:18.8722663-06:00",
      "assetClassId": 1,
      "assetDetailId": 5,
      "assetDetailTypeId": 6,
      "assetId": 7,
      "asset": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "closeDate": "2024-11-22T10:15:18.8722663-06:00",
      "constantYieldType": "sample string 8",
      "baseCurrencyCode": "sample string 9",
      "dataFeedId": 1,
      "description": "sample string 10",
      "globalAmount": 1.1,
      "issuerId": 11,
      "issuer": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "nonPerformingDate": "2024-11-22T10:15:18.8722663-06:00",
      "nonPerformingEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "notes": "sample string 12",
      "openDate": "2024-11-22T10:15:18.8722663-06:00",
      "ownerType": "sample string 13",
      "parentInstitutionId": 1,
      "parentInstitution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "parentPositionId": 14,
      "portfolioId": 15,
      "portfolio": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "positionSwapType": "sample string 16",
      "positionType": "sample string 17",
      "servicerId": 18,
      "stopAccrualDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccrualEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccretionDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccretionEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopPremiums": true,
      "stopProjectionDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopProjectionEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "swapPositionId": 20,
      "addDate": "2024-11-22T10:15:18.8722663-06:00",
      "addId": "sample string 22",
      "addNode": "sample string 23",
      "lastChangeDate": "2024-11-22T10:15:18.8722663-06:00",
      "lastChangeId": "sample string 25",
      "lastChangeNode": "sample string 26"
    },
    {
      "id": 1,
      "positionName": "sample string 2",
      "accountingCategoryId": 1,
      "administratorId": 1,
      "allowDirtyPricing": true,
      "accretionDate": "2024-11-22T10:15:18.8722663-06:00",
      "assetClassId": 1,
      "assetDetailId": 5,
      "assetDetailTypeId": 6,
      "assetId": 7,
      "asset": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "closeDate": "2024-11-22T10:15:18.8722663-06:00",
      "constantYieldType": "sample string 8",
      "baseCurrencyCode": "sample string 9",
      "dataFeedId": 1,
      "description": "sample string 10",
      "globalAmount": 1.1,
      "issuerId": 11,
      "issuer": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "nonPerformingDate": "2024-11-22T10:15:18.8722663-06:00",
      "nonPerformingEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "notes": "sample string 12",
      "openDate": "2024-11-22T10:15:18.8722663-06:00",
      "ownerType": "sample string 13",
      "parentInstitutionId": 1,
      "parentInstitution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "parentPositionId": 14,
      "portfolioId": 15,
      "portfolio": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "positionSwapType": "sample string 16",
      "positionType": "sample string 17",
      "servicerId": 18,
      "stopAccrualDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccrualEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccretionDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopAccretionEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopPremiums": true,
      "stopProjectionDate": "2024-11-22T10:15:18.8722663-06:00",
      "stopProjectionEndDate": "2024-11-22T10:15:18.8722663-06:00",
      "swapPositionId": 20,
      "addDate": "2024-11-22T10:15:18.8722663-06:00",
      "addId": "sample string 22",
      "addNode": "sample string 23",
      "lastChangeDate": "2024-11-22T10:15:18.8722663-06:00",
      "lastChangeId": "sample string 25",
      "lastChangeNode": "sample string 26"
    }
  ],
  "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:
<PagedListOfPositionListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PositionListItem>
      <AccountingCategoryId>1</AccountingCategoryId>
      <AccretionDate>2024-11-22T10:15:18.8722663-06:00</AccretionDate>
      <AddDate>2024-11-22T10:15:18.8722663-06:00</AddDate>
      <AddId>sample string 22</AddId>
      <AddNode>sample string 23</AddNode>
      <AdministratorId>1</AdministratorId>
      <AllowDirtyPricing>true</AllowDirtyPricing>
      <Asset>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Asset>
      <AssetClassId>1</AssetClassId>
      <AssetDetailId>5</AssetDetailId>
      <AssetDetailTypeId>6</AssetDetailTypeId>
      <AssetId>7</AssetId>
      <BaseCurrencyCode>sample string 9</BaseCurrencyCode>
      <CloseDate>2024-11-22T10:15:18.8722663-06:00</CloseDate>
      <ConstantYieldType>sample string 8</ConstantYieldType>
      <DataFeedId>1</DataFeedId>
      <Description>sample string 10</Description>
      <GlobalAmount>1.1</GlobalAmount>
      <Id>1</Id>
      <Issuer>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Issuer>
      <IssuerId>11</IssuerId>
      <LastChangeDate>2024-11-22T10:15:18.8722663-06:00</LastChangeDate>
      <LastChangeId>sample string 25</LastChangeId>
      <LastChangeNode>sample string 26</LastChangeNode>
      <NonPerformingDate>2024-11-22T10:15:18.8722663-06:00</NonPerformingDate>
      <NonPerformingEndDate>2024-11-22T10:15:18.8722663-06:00</NonPerformingEndDate>
      <Notes>sample string 12</Notes>
      <OpenDate>2024-11-22T10:15:18.8722663-06:00</OpenDate>
      <OwnerType>sample string 13</OwnerType>
      <ParentInstitution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </ParentInstitution>
      <ParentInstitutionId>1</ParentInstitutionId>
      <ParentPositionId>14</ParentPositionId>
      <Portfolio>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Portfolio>
      <PortfolioId>15</PortfolioId>
      <PositionName>sample string 2</PositionName>
      <PositionSwapType>sample string 16</PositionSwapType>
      <PositionType>sample string 17</PositionType>
      <ServicerId>18</ServicerId>
      <StopAccretionDate>2024-11-22T10:15:18.8722663-06:00</StopAccretionDate>
      <StopAccretionEndDate>2024-11-22T10:15:18.8722663-06:00</StopAccretionEndDate>
      <StopAccrualDate>2024-11-22T10:15:18.8722663-06:00</StopAccrualDate>
      <StopAccrualEndDate>2024-11-22T10:15:18.8722663-06:00</StopAccrualEndDate>
      <StopPremiums>true</StopPremiums>
      <StopProjectionDate>2024-11-22T10:15:18.8722663-06:00</StopProjectionDate>
      <StopProjectionEndDate>2024-11-22T10:15:18.8722663-06:00</StopProjectionEndDate>
      <SwapPositionId>20</SwapPositionId>
    </PositionListItem>
    <PositionListItem>
      <AccountingCategoryId>1</AccountingCategoryId>
      <AccretionDate>2024-11-22T10:15:18.8722663-06:00</AccretionDate>
      <AddDate>2024-11-22T10:15:18.8722663-06:00</AddDate>
      <AddId>sample string 22</AddId>
      <AddNode>sample string 23</AddNode>
      <AdministratorId>1</AdministratorId>
      <AllowDirtyPricing>true</AllowDirtyPricing>
      <Asset>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Asset>
      <AssetClassId>1</AssetClassId>
      <AssetDetailId>5</AssetDetailId>
      <AssetDetailTypeId>6</AssetDetailTypeId>
      <AssetId>7</AssetId>
      <BaseCurrencyCode>sample string 9</BaseCurrencyCode>
      <CloseDate>2024-11-22T10:15:18.8722663-06:00</CloseDate>
      <ConstantYieldType>sample string 8</ConstantYieldType>
      <DataFeedId>1</DataFeedId>
      <Description>sample string 10</Description>
      <GlobalAmount>1.1</GlobalAmount>
      <Id>1</Id>
      <Issuer>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Issuer>
      <IssuerId>11</IssuerId>
      <LastChangeDate>2024-11-22T10:15:18.8722663-06:00</LastChangeDate>
      <LastChangeId>sample string 25</LastChangeId>
      <LastChangeNode>sample string 26</LastChangeNode>
      <NonPerformingDate>2024-11-22T10:15:18.8722663-06:00</NonPerformingDate>
      <NonPerformingEndDate>2024-11-22T10:15:18.8722663-06:00</NonPerformingEndDate>
      <Notes>sample string 12</Notes>
      <OpenDate>2024-11-22T10:15:18.8722663-06:00</OpenDate>
      <OwnerType>sample string 13</OwnerType>
      <ParentInstitution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </ParentInstitution>
      <ParentInstitutionId>1</ParentInstitutionId>
      <ParentPositionId>14</ParentPositionId>
      <Portfolio>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Portfolio>
      <PortfolioId>15</PortfolioId>
      <PositionName>sample string 2</PositionName>
      <PositionSwapType>sample string 16</PositionSwapType>
      <PositionType>sample string 17</PositionType>
      <ServicerId>18</ServicerId>
      <StopAccretionDate>2024-11-22T10:15:18.8722663-06:00</StopAccretionDate>
      <StopAccretionEndDate>2024-11-22T10:15:18.8722663-06:00</StopAccretionEndDate>
      <StopAccrualDate>2024-11-22T10:15:18.8722663-06:00</StopAccrualDate>
      <StopAccrualEndDate>2024-11-22T10:15:18.8722663-06:00</StopAccrualEndDate>
      <StopPremiums>true</StopPremiums>
      <StopProjectionDate>2024-11-22T10:15:18.8722663-06:00</StopProjectionDate>
      <StopProjectionEndDate>2024-11-22T10:15:18.8722663-06:00</StopProjectionEndDate>
      <SwapPositionId>20</SwapPositionId>
    </PositionListItem>
  </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>
</PagedListOfPositionListItem>



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.