POST api/Property/NameTypeAheadSearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirstName	string	None.
LastOrCompanyName	string	None.
MiddleName	string	None.
NameType	NameSearchTypeEnum	None.
Soundex	integer	None.
SearchNicknames	boolean	None.
CountyFips	string	None.
Name	string	None.
IsRunReverse	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastOrCompanyName": "sample string 2",
  "MiddleName": "sample string 3",
  "NameType": 0,
  "Soundex": 1,
  "SearchNicknames": true,
  "CountyFips": "sample string 5",
  "Name": "sample string 6",
  "IsRunReverse": true
}

application/xml, text/xml

Sample:

<PreselectNameSearchRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataTrace.TypeAheadSearch.Models">
  <CountyFips>sample string 5</CountyFips>
  <FirstName>sample string 1</FirstName>
  <IsRunReverse>true</IsRunReverse>
  <LastOrCompanyName>sample string 2</LastOrCompanyName>
  <MiddleName>sample string 3</MiddleName>
  <Name>sample string 6</Name>
  <NameType>Individual</NameType>
  <SearchNicknames>true</SearchNicknames>
  <Soundex>1</Soundex>
</PreselectNameSearchRequestDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PreselectNameSearchRecordDto

Name	Type	Additional information
id	string	None.
last_company_name	string	None.
last_company_name_normalized	string	None.
last_company_name_phonetic	string	None.
first_name	string	None.
first_name_synonym	string	None.
first_name_phonetic	string	None.
middle_name	string	None.
ur_full_name	string	None.
ur_full_name_normalized	string	None.
ur_full_name_phonetic	string	None.
sdn_soundex_code	string	None.
@search.score	decimal number	None.
fips_code	string	None.
md5	globally unique identifier	None.
DocumentCount	integer	None.
HasExceededLimit	boolean	None.
ValidationMessage	string	None.
NameIndicator	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "sample string 1",
    "last_company_name": "sample string 2",
    "last_company_name_normalized": "sample string 3",
    "last_company_name_phonetic": "sample string 4",
    "first_name": "sample string 5",
    "first_name_synonym": "sample string 6",
    "first_name_phonetic": "sample string 7",
    "middle_name": "sample string 8",
    "ur_full_name": "sample string 9",
    "ur_full_name_normalized": "sample string 10",
    "ur_full_name_phonetic": "sample string 11",
    "sdn_soundex_code": "sample string 12",
    "@search.score": 13.0,
    "fips_code": "sample string 14",
    "md5": "55c97c59-c2db-4ae0-a322-54e6ce13a955",
    "DocumentCount": 16,
    "HasExceededLimit": true,
    "ValidationMessage": "sample string 18",
    "NameIndicator": "sample string 19"
  },
  {
    "id": "sample string 1",
    "last_company_name": "sample string 2",
    "last_company_name_normalized": "sample string 3",
    "last_company_name_phonetic": "sample string 4",
    "first_name": "sample string 5",
    "first_name_synonym": "sample string 6",
    "first_name_phonetic": "sample string 7",
    "middle_name": "sample string 8",
    "ur_full_name": "sample string 9",
    "ur_full_name_normalized": "sample string 10",
    "ur_full_name_phonetic": "sample string 11",
    "sdn_soundex_code": "sample string 12",
    "@search.score": 13.0,
    "fips_code": "sample string 14",
    "md5": "55c97c59-c2db-4ae0-a322-54e6ce13a955",
    "DocumentCount": 16,
    "HasExceededLimit": true,
    "ValidationMessage": "sample string 18",
    "NameIndicator": "sample string 19"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPreselectNameSearchRecordDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataTrace.TypeAheadSearch.Models">
  <PreselectNameSearchRecordDto>
    <DocumentCount>16</DocumentCount>
    <FipsCode>sample string 14</FipsCode>
    <FirstName>sample string 5</FirstName>
    <FirstNamePhonetic>sample string 7</FirstNamePhonetic>
    <FirstNameSynonym>sample string 6</FirstNameSynonym>
    <HasExceededLimit>true</HasExceededLimit>
    <Id>sample string 1</Id>
    <LastCompanyName>sample string 2</LastCompanyName>
    <LastCompanyNameNormalized>sample string 3</LastCompanyNameNormalized>
    <LastCompanyNamePhonetic>sample string 4</LastCompanyNamePhonetic>
    <MiddleName>sample string 8</MiddleName>
    <NameId>55c97c59-c2db-4ae0-a322-54e6ce13a955</NameId>
    <NameIndicator>sample string 19</NameIndicator>
    <SDNSoundexCode>sample string 12</SDNSoundexCode>
    <SearchScore>13</SearchScore>
    <URFullName>sample string 9</URFullName>
    <URFullNameNormalized>sample string 10</URFullNameNormalized>
    <URFullNamePhonetic>sample string 11</URFullNamePhonetic>
    <ValidationMessage>sample string 18</ValidationMessage>
  </PreselectNameSearchRecordDto>
  <PreselectNameSearchRecordDto>
    <DocumentCount>16</DocumentCount>
    <FipsCode>sample string 14</FipsCode>
    <FirstName>sample string 5</FirstName>
    <FirstNamePhonetic>sample string 7</FirstNamePhonetic>
    <FirstNameSynonym>sample string 6</FirstNameSynonym>
    <HasExceededLimit>true</HasExceededLimit>
    <Id>sample string 1</Id>
    <LastCompanyName>sample string 2</LastCompanyName>
    <LastCompanyNameNormalized>sample string 3</LastCompanyNameNormalized>
    <LastCompanyNamePhonetic>sample string 4</LastCompanyNamePhonetic>
    <MiddleName>sample string 8</MiddleName>
    <NameId>55c97c59-c2db-4ae0-a322-54e6ce13a955</NameId>
    <NameIndicator>sample string 19</NameIndicator>
    <SDNSoundexCode>sample string 12</SDNSoundexCode>
    <SearchScore>13</SearchScore>
    <URFullName>sample string 9</URFullName>
    <URFullNameNormalized>sample string 10</URFullNameNormalized>
    <URFullNamePhonetic>sample string 11</URFullNamePhonetic>
    <ValidationMessage>sample string 18</ValidationMessage>
  </PreselectNameSearchRecordDto>
</ArrayOfPreselectNameSearchRecordDto>