POST {version}/EntitiesQuickSearch
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
QuickSearchRequestName | Description | Type | Additional information |
---|---|---|---|
Query | string |
None. |
|
RequestId | integer |
None. |
|
RecordCount | integer |
None. |
|
InActive | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Query": "sample string 1", "RequestId": 2, "RecordCount": 1, "InActive": true }
application/xml, text/xml
Sample:
<QuickSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <InActive>true</InActive> <Query>sample string 1</Query> <RecordCount>1</RecordCount> <RequestId>2</RequestId> </QuickSearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
QuickSearchResultName | Description | Type | Additional information |
---|---|---|---|
Results | Collection of QuickSearchEntity |
None. |
|
Count | integer |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Results": [ { "RowNum": 1, "Id": "b5c6aa7a-246a-446e-b184-d9083ee7f56d", "SourceId": "sample string 1", "Name": "sample string 2", "Inactive": true, "Address": "sample string 4", "IsCommittee": true, "IsIndividual": true, "IsLegislator": true, "IsOrganization": true, "HasContributions": true, "HasExpenses": true, "IsExternal": true, "Type": 0 }, { "RowNum": 1, "Id": "b5c6aa7a-246a-446e-b184-d9083ee7f56d", "SourceId": "sample string 1", "Name": "sample string 2", "Inactive": true, "Address": "sample string 4", "IsCommittee": true, "IsIndividual": true, "IsLegislator": true, "IsOrganization": true, "HasContributions": true, "HasExpenses": true, "IsExternal": true, "Type": 0 } ], "Count": 1, "Id": 2 }
application/xml, text/xml
Sample:
<QuickSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <Count>1</Count> <Id>2</Id> <Results> <QuickSearchEntity> <Address>sample string 4</Address> <HasContributions>true</HasContributions> <HasExpenses>true</HasExpenses> <Id>b5c6aa7a-246a-446e-b184-d9083ee7f56d</Id> <Inactive>true</Inactive> <IsCommittee>true</IsCommittee> <IsExternal>true</IsExternal> <IsIndividual>true</IsIndividual> <IsLegislator>true</IsLegislator> <IsOrganization>true</IsOrganization> <Name>sample string 2</Name> <RowNum>1</RowNum> <SourceId>sample string 1</SourceId> <Type>None</Type> </QuickSearchEntity> <QuickSearchEntity> <Address>sample string 4</Address> <HasContributions>true</HasContributions> <HasExpenses>true</HasExpenses> <Id>b5c6aa7a-246a-446e-b184-d9083ee7f56d</Id> <Inactive>true</Inactive> <IsCommittee>true</IsCommittee> <IsExternal>true</IsExternal> <IsIndividual>true</IsIndividual> <IsLegislator>true</IsLegislator> <IsOrganization>true</IsOrganization> <Name>sample string 2</Name> <RowNum>1</RowNum> <SourceId>sample string 1</SourceId> <Type>None</Type> </QuickSearchEntity> </Results> </QuickSearchResult>