|
IHS Markit API |
GET v1/Positions/{id}
Description
Retrieve position with WSO ID of {id}.
Base Url
https://services.wsoweb.com/
Rest Call Syntax
GET PositionManagement/v1/Positions/{id}
GET PositionManagement/v1/Positions/{id}
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
id
WSO ID of the position
integer
Required
Response Information
Position
Name
Description
Type
Additional Information
AccountingCategoryId
A category that can be used to describe a position. This is primarily used by the accounting module for mapping overrides, however it can be used for additional custom reporting as well.
integer
AccretionDate
The date to which you would like to amortize discounts or premiums associated with the trades in this loan account
date
AddDate
Gets or sets the date that a record was added to the database.
date
AddId
Gets or sets the UserId of the user who added the record.
string
AddNode
Gets or sets the name of the machine where the record was added from.
string
AdministratorId
The administrator that manages the position within the company that is tracking the position.
integer
AllowDirtyPricing
True or false - Can this position have dirty pricing?
boolean
AssetClassId
A pointer to the asset class that this position is associated with.
integer
AssetDetailId
This points to the asset detail object (bond, equity, universal, or facility)
integer
AssetDetailTypeId
This points to the asset detail object (bond, equity, universal, or facility)
integer
AssetId
A pointer to the asset (common asset object) that defines the position.
integer
BaseCurrencyCode
The currency type of the asset of this position
string
CloseDate
The date that the position was reduced to zero. It will contain the max date (9/9/9999) if there is an active position.
date
ConstantYieldType
Indicates type of Constant Yield used when Constant Yield Amortization is performed
string
DataFeedId
The name of the external data importing source for this asset.
integer
Description
A description of the position.
string
GlobalAmount
The amount of the global that is allocated to this loan position on a settled basis.
decimal number
Id
integer
IssuerId
The issuer that this position belongs to.
integer
LastChangeDate
Gets or sets the date when the record was last changed.
date
LastChangeId
Gets or sets the UserId of the user who last changed this record.
string
LastChangeNode
Gets or sets the name of the machine where the record was last changed from.
string
NonPerformingDate
The date that the position was set to non-performing status. If this date is blank, the asset is performing. This is informational only and does not change any calculations.
date
NonPerformingEndDate
The date that the position started performing again after going into non performing status. 9/9/9999 means that there is no end date to the non performing status.
date
Notes
Notes
string
OpenDate
The date that this position was opened (date of first trade).
date
OwnerType
The type of parent institution. Generally this applies to bank loans to track whether this in an assignment or participation.
string
ParentInstitutionId
The institution with which the owner sends and receives the cash flows (usually the agent bank or the partipation counter party)
integer
ParentPositionId
The parent position of the current position. Only used by WSO Agent functionality.
integer
PortfolioId
Portfolio that the position belongs to.
integer
PositionName
string
PositionSwapType
Indicates if the position is not swapped, swapped or is a reference
string
PositionType
Use this flag indicating if the position is long - 1 or short - 2.
string
ServicerId
The servicer for this position (ABS only).
integer
StopAccretionDate
The date when the position stops amortizing discounts (and premiums if the StopPremiums option is selected)
date
StopAccretionEndDate
The date when the position starts amortizing discounts again.
date
StopAccrualDate
The date when the position stops accruing interest (and accruable fees for loans).
date
StopAccrualEndDate
The date when the position starts accruing interest again.
date
StopPremiums
Determines if premiums will be amortized if the Stop Amortization Date is set.
boolean
StopProjectionDate
The date when the position stops projecting interest. This will not affect accruals.
date
StopProjectionEndDate
The date when the position starts projecting interest again.
date
SwapPositionId
Pointer to related Swap/Reference position
integer
Response Body Formats
application/json, text/json
{
"id": 1,
"positionName": "sample string 2",
"accountingCategoryId": 1,
"administratorId": 1,
"allowDirtyPricing": true,
"accretionDate": "2024-11-22T12:30:49.619728-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-22T12:30:49.6200117-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-22T12:30:49.6205537-06:00",
"nonPerformingEndDate": "2024-11-22T12:30:49.6205537-06:00",
"notes": "sample string 12",
"openDate": "2024-11-22T12:30:49.6205537-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-22T12:30:49.6208861-06:00",
"stopAccrualEndDate": "2024-11-22T12:30:49.6208861-06:00",
"stopAccretionDate": "2024-11-22T12:30:49.6208861-06:00",
"stopAccretionEndDate": "2024-11-22T12:30:49.6208861-06:00",
"stopPremiums": true,
"stopProjectionDate": "2024-11-22T12:30:49.6208861-06:00",
"stopProjectionEndDate": "2024-11-22T12:30:49.6214242-06:00",
"swapPositionId": 20,
"addDate": "2024-11-22T12:30:49.6214242-06:00",
"addId": "sample string 22",
"addNode": "sample string 23",
"lastChangeDate": "2024-11-22T12:30:49.6216937-06:00",
"lastChangeId": "sample string 25",
"lastChangeNode": "sample string 26",
"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
<Position xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AccountingCategoryId>1</AccountingCategoryId>
<AccretionDate>2024-11-22T12:30:49.619728-06:00</AccretionDate>
<AddDate>2024-11-22T12:30:49.6214242-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-22T12:30:49.6200117-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-22T12:30:49.6216937-06:00</LastChangeDate>
<LastChangeId>sample string 25</LastChangeId>
<LastChangeNode>sample string 26</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>
<NonPerformingDate>2024-11-22T12:30:49.6205537-06:00</NonPerformingDate>
<NonPerformingEndDate>2024-11-22T12:30:49.6205537-06:00</NonPerformingEndDate>
<Notes>sample string 12</Notes>
<OpenDate>2024-11-22T12:30:49.6205537-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-22T12:30:49.6208861-06:00</StopAccretionDate>
<StopAccretionEndDate>2024-11-22T12:30:49.6208861-06:00</StopAccretionEndDate>
<StopAccrualDate>2024-11-22T12:30:49.6208861-06:00</StopAccrualDate>
<StopAccrualEndDate>2024-11-22T12:30:49.6208861-06:00</StopAccrualEndDate>
<StopPremiums>true</StopPremiums>
<StopProjectionDate>2024-11-22T12:30:49.6208861-06:00</StopProjectionDate>
<StopProjectionEndDate>2024-11-22T12:30:49.6214242-06:00</StopProjectionEndDate>
<SwapPositionId>20</SwapPositionId>
</Position>