GET v1/Search?searchString={searchString}&locationID={locationID}
Perform a basic search
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchString |
Search String |
string |
Default value is |
locationID |
OPTIONAL Location ID |
string |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
Basic search result
SearchResultDTOName | Description | Type | Additional information |
---|---|---|---|
ElapsedMilliseconds | integer |
None. |
|
ResultCount | integer |
None. |
|
ErrorMessage | string |
None. |
|
Contacts | Collection of SearchResultContactDTO |
None. |
Response Formats
application/json, text/json
Sample:
{ "Contacts": [ { "EntityId": 1, "ContactName": "sample string 2", "ContactType": "sample string 3", "ContactSubtype": "sample string 4", "ContactTypeName": "sample string 5", "CustomerNumber": "sample string 6", "PrimaryPhone": "sample string 7", "PrimaryPhoneType": "sample string 8", "PrimaryEmail": "sample string 9", "PrimaryAddressLine1": "sample string 10", "PrimaryAddressLine2": "sample string 11", "PrimaryAddressCity": "sample string 12", "PrimaryAddressState": "sample string 13", "PrimaryAddressZip": "sample string 14", "LocationName": "sample string 15", "OfficeId": 16, "StatusString": "sample string 17", "MatchedPolicyList": [ { "PolicyId": 1, "PolicyNumber": "sample string 2", "EffectiveDate": "2024-12-11T06:16:58.5924866+00:00", "ExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 5", "LobString": "sample string 6", "MatchedNamedInsured": [ "sample string 1", "sample string 2" ], "MatchedQuotes": [ { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" } ], "CanView": true, "EffectiveDateDisplay": "12/11/2024", "ExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "PolicyNumber": "sample string 2", "EffectiveDate": "2024-12-11T06:16:58.5924866+00:00", "ExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 5", "LobString": "sample string 6", "MatchedNamedInsured": [ "sample string 1", "sample string 2" ], "MatchedQuotes": [ { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" } ], "CanView": true, "EffectiveDateDisplay": "12/11/2024", "ExpirationDateDisplay": "12/11/2024" } ], "MatchedAdditionalContacts": [ "sample string 1", "sample string 2" ], "MatchedNaic": "sample string 18", "MatchedDba": "sample string 19", "MatchedPhones": [ "sample string 1", "sample string 2" ], "MatchedEmails": [ "sample string 1", "sample string 2" ], "MatchedAddresses": [ "sample string 1", "sample string 2" ], "ClickLinkUrl": "sample string 20" }, { "EntityId": 1, "ContactName": "sample string 2", "ContactType": "sample string 3", "ContactSubtype": "sample string 4", "ContactTypeName": "sample string 5", "CustomerNumber": "sample string 6", "PrimaryPhone": "sample string 7", "PrimaryPhoneType": "sample string 8", "PrimaryEmail": "sample string 9", "PrimaryAddressLine1": "sample string 10", "PrimaryAddressLine2": "sample string 11", "PrimaryAddressCity": "sample string 12", "PrimaryAddressState": "sample string 13", "PrimaryAddressZip": "sample string 14", "LocationName": "sample string 15", "OfficeId": 16, "StatusString": "sample string 17", "MatchedPolicyList": [ { "PolicyId": 1, "PolicyNumber": "sample string 2", "EffectiveDate": "2024-12-11T06:16:58.5924866+00:00", "ExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 5", "LobString": "sample string 6", "MatchedNamedInsured": [ "sample string 1", "sample string 2" ], "MatchedQuotes": [ { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" } ], "CanView": true, "EffectiveDateDisplay": "12/11/2024", "ExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "PolicyNumber": "sample string 2", "EffectiveDate": "2024-12-11T06:16:58.5924866+00:00", "ExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 5", "LobString": "sample string 6", "MatchedNamedInsured": [ "sample string 1", "sample string 2" ], "MatchedQuotes": [ { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" }, { "PolicyId": 1, "QuoteId": 2, "QuoteNumber": "sample string 3", "QuoteDate": "2024-12-11T06:16:58.5924866+00:00", "QuoteExpirationDate": "2024-12-11T06:16:58.5924866+00:00", "Carrier": "sample string 4", "LobString": "sample string 5", "CanView": true, "QuoteDateDisplay": "12/11/2024", "QuoteExpirationDateDisplay": "12/11/2024" } ], "CanView": true, "EffectiveDateDisplay": "12/11/2024", "ExpirationDateDisplay": "12/11/2024" } ], "MatchedAdditionalContacts": [ "sample string 1", "sample string 2" ], "MatchedNaic": "sample string 18", "MatchedDba": "sample string 19", "MatchedPhones": [ "sample string 1", "sample string 2" ], "MatchedEmails": [ "sample string 1", "sample string 2" ], "MatchedAddresses": [ "sample string 1", "sample string 2" ], "ClickLinkUrl": "sample string 20" } ], "ElapsedMilliseconds": 1, "ResultCount": 2, "ErrorMessage": "sample string 3" }
application/xml, text/xml
Sample:
<SearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts"> <Contacts> <SearchResultContactDTO> <ClickLinkUrl>sample string 20</ClickLinkUrl> <ContactName>sample string 2</ContactName> <ContactSubtype>sample string 4</ContactSubtype> <ContactType>sample string 3</ContactType> <ContactTypeName>sample string 5</ContactTypeName> <CustomerNumber>sample string 6</CustomerNumber> <EntityId>1</EntityId> <LocationName>sample string 15</LocationName> <MatchedAdditionalContacts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedAdditionalContacts> <MatchedAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedAddresses> <MatchedDba>sample string 19</MatchedDba> <MatchedEmails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedEmails> <MatchedNaic>sample string 18</MatchedNaic> <MatchedPhones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedPhones> <MatchedPolicyList> <SearchResultPolicyDTO> <CanView>true</CanView> <Carrier>sample string 5</Carrier> <EffectiveDate>2024-12-11T06:16:58.5924866+00:00</EffectiveDate> <ExpirationDate>2024-12-11T06:16:58.5924866+00:00</ExpirationDate> <LobString>sample string 6</LobString> <MatchedNamedInsured xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </MatchedNamedInsured> <MatchedQuotes> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> </MatchedQuotes> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> </SearchResultPolicyDTO> <SearchResultPolicyDTO> <CanView>true</CanView> <Carrier>sample string 5</Carrier> <EffectiveDate>2024-12-11T06:16:58.5924866+00:00</EffectiveDate> <ExpirationDate>2024-12-11T06:16:58.5924866+00:00</ExpirationDate> <LobString>sample string 6</LobString> <MatchedNamedInsured xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </MatchedNamedInsured> <MatchedQuotes> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> </MatchedQuotes> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> </SearchResultPolicyDTO> </MatchedPolicyList> <OfficeId>16</OfficeId> <PrimaryAddressCity>sample string 12</PrimaryAddressCity> <PrimaryAddressLine1>sample string 10</PrimaryAddressLine1> <PrimaryAddressLine2>sample string 11</PrimaryAddressLine2> <PrimaryAddressState>sample string 13</PrimaryAddressState> <PrimaryAddressZip>sample string 14</PrimaryAddressZip> <PrimaryEmail>sample string 9</PrimaryEmail> <PrimaryPhone>sample string 7</PrimaryPhone> <PrimaryPhoneType>sample string 8</PrimaryPhoneType> <StatusString>sample string 17</StatusString> </SearchResultContactDTO> <SearchResultContactDTO> <ClickLinkUrl>sample string 20</ClickLinkUrl> <ContactName>sample string 2</ContactName> <ContactSubtype>sample string 4</ContactSubtype> <ContactType>sample string 3</ContactType> <ContactTypeName>sample string 5</ContactTypeName> <CustomerNumber>sample string 6</CustomerNumber> <EntityId>1</EntityId> <LocationName>sample string 15</LocationName> <MatchedAdditionalContacts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedAdditionalContacts> <MatchedAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedAddresses> <MatchedDba>sample string 19</MatchedDba> <MatchedEmails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedEmails> <MatchedNaic>sample string 18</MatchedNaic> <MatchedPhones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </MatchedPhones> <MatchedPolicyList> <SearchResultPolicyDTO> <CanView>true</CanView> <Carrier>sample string 5</Carrier> <EffectiveDate>2024-12-11T06:16:58.5924866+00:00</EffectiveDate> <ExpirationDate>2024-12-11T06:16:58.5924866+00:00</ExpirationDate> <LobString>sample string 6</LobString> <MatchedNamedInsured xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </MatchedNamedInsured> <MatchedQuotes> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> </MatchedQuotes> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> </SearchResultPolicyDTO> <SearchResultPolicyDTO> <CanView>true</CanView> <Carrier>sample string 5</Carrier> <EffectiveDate>2024-12-11T06:16:58.5924866+00:00</EffectiveDate> <ExpirationDate>2024-12-11T06:16:58.5924866+00:00</ExpirationDate> <LobString>sample string 6</LobString> <MatchedNamedInsured xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </MatchedNamedInsured> <MatchedQuotes> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> <SearchResultQuoteDTO> <CanView>true</CanView> <Carrier>sample string 4</Carrier> <LobString>sample string 5</LobString> <PolicyId>1</PolicyId> <QuoteDate>2024-12-11T06:16:58.5924866+00:00</QuoteDate> <QuoteExpirationDate>2024-12-11T06:16:58.5924866+00:00</QuoteExpirationDate> <QuoteId>2</QuoteId> <QuoteNumber>sample string 3</QuoteNumber> </SearchResultQuoteDTO> </MatchedQuotes> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> </SearchResultPolicyDTO> </MatchedPolicyList> <OfficeId>16</OfficeId> <PrimaryAddressCity>sample string 12</PrimaryAddressCity> <PrimaryAddressLine1>sample string 10</PrimaryAddressLine1> <PrimaryAddressLine2>sample string 11</PrimaryAddressLine2> <PrimaryAddressState>sample string 13</PrimaryAddressState> <PrimaryAddressZip>sample string 14</PrimaryAddressZip> <PrimaryEmail>sample string 9</PrimaryEmail> <PrimaryPhone>sample string 7</PrimaryPhone> <PrimaryPhoneType>sample string 8</PrimaryPhoneType> <StatusString>sample string 17</StatusString> </SearchResultContactDTO> </Contacts> <ElapsedMilliseconds>1</ElapsedMilliseconds> <ErrorMessage>sample string 3</ErrorMessage> <ResultCount>2</ResultCount> </SearchResultDTO>