POST v1/AdvancedSearch/AdvancedSearch
Advanced search using company name or bond issuer name, and in additon one or more data series based filters. For example, you can search for a bond issuer having name containing "northern" and bond duration greater than 1.
Request Information
Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| request | AdvancedSearchRequest | Container for the AdvancedSearch input parameters. See parameter details below. For practical examples see CreditEdge SDK Test Client application. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"searchType": "Entity",
"filter": {
"companyName": "sample string 1",
"bondIssuerName": "sample string 2",
"startDate": "sample string 3",
"endDate": "sample string 4",
"criteria": [
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
},
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
},
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
}
]
},
"sdkVersion": "sample string 1"
}
application/xml, text/xml
Sample:
<AdvancedSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<SdkVersion>sample string 1</SdkVersion>
<Filter xmlns:d2p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.Web.Api.Contract.DataObjects">
<d2p1:BondIssuerName>sample string 2</d2p1:BondIssuerName>
<d2p1:CompanyName>sample string 1</d2p1:CompanyName>
<d2p1:Criteria>
<d2p1:AdvancedSearchCriteria>
<d2p1:FilterLevel>sample string 1</d2p1:FilterLevel>
<d2p1:Name>sample string 5</d2p1:Name>
<d2p1:Operator>sample string 3</d2p1:Operator>
<d2p1:SeriesType>sample string 2</d2p1:SeriesType>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:AdvancedSearchCriteria>
<d2p1:AdvancedSearchCriteria>
<d2p1:FilterLevel>sample string 1</d2p1:FilterLevel>
<d2p1:Name>sample string 5</d2p1:Name>
<d2p1:Operator>sample string 3</d2p1:Operator>
<d2p1:SeriesType>sample string 2</d2p1:SeriesType>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:AdvancedSearchCriteria>
<d2p1:AdvancedSearchCriteria>
<d2p1:FilterLevel>sample string 1</d2p1:FilterLevel>
<d2p1:Name>sample string 5</d2p1:Name>
<d2p1:Operator>sample string 3</d2p1:Operator>
<d2p1:SeriesType>sample string 2</d2p1:SeriesType>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:AdvancedSearchCriteria>
</d2p1:Criteria>
<d2p1:EndDate>sample string 4</d2p1:EndDate>
<d2p1:StartDate>sample string 3</d2p1:StartDate>
</Filter>
<SearchType>Entity</SearchType>
</AdvancedSearchRequest>
Parameter Information
Parameter Name: request
| Property | Type | Description |
|---|---|---|
| SearchType | FilterResultType | |
| Filter | AdvancedSearchFilter | |
| SdkVersion | String | If the client is using the SDK, the version number will be passed along with the request. This field is optional. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"resultList": [
{
"resultType": 0,
"idList": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
{
"resultType": 0,
"idList": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
{
"resultType": 0,
"idList": [
"sample string 1",
"sample string 2",
"sample string 3"
]
}
],
"errorOccurred": false,
"errorMessages": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"request": {
"searchType": "Entity",
"filter": {
"companyName": "sample string 1",
"bondIssuerName": "sample string 2",
"startDate": "sample string 3",
"endDate": "sample string 4",
"criteria": [
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
},
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
},
{
"filterLevel": "sample string 1",
"seriesType": "sample string 2",
"operator": "sample string 3",
"value": "sample string 4",
"name": "sample string 5"
}
]
},
"sdkVersion": "sample string 1"
}
}
application/xml, text/xml
Sample:
<AdvancedSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</ErrorMessages>
<ErrorOccurred>false</ErrorOccurred>
<Request>
<SdkVersion>sample string 1</SdkVersion>
<Filter xmlns:d3p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.Web.Api.Contract.DataObjects">
<d3p1:BondIssuerName>sample string 2</d3p1:BondIssuerName>
<d3p1:CompanyName>sample string 1</d3p1:CompanyName>
<d3p1:Criteria>
<d3p1:AdvancedSearchCriteria>
<d3p1:FilterLevel>sample string 1</d3p1:FilterLevel>
<d3p1:Name>sample string 5</d3p1:Name>
<d3p1:Operator>sample string 3</d3p1:Operator>
<d3p1:SeriesType>sample string 2</d3p1:SeriesType>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:AdvancedSearchCriteria>
<d3p1:AdvancedSearchCriteria>
<d3p1:FilterLevel>sample string 1</d3p1:FilterLevel>
<d3p1:Name>sample string 5</d3p1:Name>
<d3p1:Operator>sample string 3</d3p1:Operator>
<d3p1:SeriesType>sample string 2</d3p1:SeriesType>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:AdvancedSearchCriteria>
<d3p1:AdvancedSearchCriteria>
<d3p1:FilterLevel>sample string 1</d3p1:FilterLevel>
<d3p1:Name>sample string 5</d3p1:Name>
<d3p1:Operator>sample string 3</d3p1:Operator>
<d3p1:SeriesType>sample string 2</d3p1:SeriesType>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:AdvancedSearchCriteria>
</d3p1:Criteria>
<d3p1:EndDate>sample string 4</d3p1:EndDate>
<d3p1:StartDate>sample string 3</d3p1:StartDate>
</Filter>
<SearchType>Entity</SearchType>
</Request>
<ResultList xmlns:d2p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.Web.Api.Contract.DataObjects">
<d2p1:FilterResult>
<d2p1:IdList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
<d4p1:string>sample string 3</d4p1:string>
</d2p1:IdList>
<d2p1:ResultType>Entity</d2p1:ResultType>
</d2p1:FilterResult>
<d2p1:FilterResult>
<d2p1:IdList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
<d4p1:string>sample string 3</d4p1:string>
</d2p1:IdList>
<d2p1:ResultType>Entity</d2p1:ResultType>
</d2p1:FilterResult>
<d2p1:FilterResult>
<d2p1:IdList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
<d4p1:string>sample string 3</d4p1:string>
</d2p1:IdList>
<d2p1:ResultType>Entity</d2p1:ResultType>
</d2p1:FilterResult>
</ResultList>
</AdvancedSearchResponse>