|
IHS Markit API |
GET v1/Contracts
Description
Retrieve list of Contracts satisfying the input search criteria.
Base Url
https://api-gafg.wsohosting.com/
Rest Call Syntax
GET Contract/v1/Contracts
GET Contract/v1/Contracts
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
AssetId
This value will allow a contract search by Asset ID
integer
Required if Position ID is not supplied.
LimitToMostRecentPosition
This value will allow a contract search by the the most recently created position with contracts and returns those contracts.
boolean
AssetID is required when using this search criteria.
PositionId
This value will allow a contract search by Position ID
integer
Required if Asset ID is not supplied.
EffectiveDate
This value will allow a contract search by EffectiveDate where the EffectiveDate is within the contract start and maturity date excluding the maturity date
date
IsActive
This value will allow a contract search by IsActive where the IsActive tells whether the contract is active or not
boolean
PageNumber
Specified Page number to search
integer
PageSize
Specified Page size to search
integer
Response Information
PagedList Of ContractListItem
Name
Description
Type
Additional Information
Response Body Formats
application/json, text/json
{
"items": [
{
"id": 1,
"contractName": "sample string 2",
"isActive": 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"
}
]
},
{
"id": 1,
"contractName": "sample string 2",
"isActive": 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"
}
]
}
],
"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
<PagedListOfContractListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Items>
<ContractListItem>
<ContractName>sample string 2</ContractName>
<Id>1</Id>
<IsActive>true</IsActive>
<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>
</ContractListItem>
<ContractListItem>
<ContractName>sample string 2</ContractName>
<Id>1</Id>
<IsActive>true</IsActive>
<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>
</ContractListItem>
</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>
</PagedListOfContractListItem>