POST Search/getentities

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
query	string	None.
limit	integer	None.
token	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "query": "sample string 1",
  "limit": 2,
  "token": "a07890a4-4855-47ba-9814-af8c7ff65a34"
}

application/xml, text/xml

Sample:

<GetEntitiesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Search">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">a07890a4-4855-47ba-9814-af8c7ff65a34</token>
  <limit>2</limit>
  <query>sample string 1</query>
</GetEntitiesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EntitiesList

Name	Type	Additional information
Entities	Collection of Entity	None.
code	integer	None.
error	string	None.
APIVersion	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "APIVersion": 1,
  "Entities": [
    {
      "HomePhone": "sample string 1",
      "WorkPhone": "sample string 2",
      "CellPhone": "sample string 3",
      "Email": "sample string 4",
      "StillOwn": true,
      "VIN": "sample string 6",
      "EntityID": "526922ae-1ca3-4a8c-b8f4-f616345a95d5",
      "FullName": "sample string 7",
      "TrimID": 1,
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsContractEnd": true,
      "IsServiceAlert": true,
      "IsServiceApptAlert": true,
      "IsCreditConvert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Kind": "sample string 8"
    },
    {
      "HomePhone": "sample string 1",
      "WorkPhone": "sample string 2",
      "CellPhone": "sample string 3",
      "Email": "sample string 4",
      "StillOwn": true,
      "VIN": "sample string 6",
      "EntityID": "526922ae-1ca3-4a8c-b8f4-f616345a95d5",
      "FullName": "sample string 7",
      "TrimID": 1,
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsContractEnd": true,
      "IsServiceAlert": true,
      "IsServiceApptAlert": true,
      "IsCreditConvert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Kind": "sample string 8"
    }
  ],
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:

<EntitiesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <Entities>
    <Entity>
      <Kind>sample string 8</Kind>
      <EntityID>526922ae-1ca3-4a8c-b8f4-f616345a95d5</EntityID>
      <FullName>sample string 7</FullName>
      <IsAlert>true</IsAlert>
      <IsContractEnd>true</IsContractEnd>
      <IsCreditConvert>true</IsCreditConvert>
      <IsEngagedAlert>true</IsEngagedAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsInMarketAlert>true</IsInMarketAlert>
      <IsMileageAlert>true</IsMileageAlert>
      <IsServiceAlert>true</IsServiceAlert>
      <IsServiceApptAlert>true</IsServiceApptAlert>
      <IsWarrantyAlert>true</IsWarrantyAlert>
      <TrimID>1</TrimID>
      <CellPhone>sample string 3</CellPhone>
      <Email>sample string 4</Email>
      <HomePhone>sample string 1</HomePhone>
      <StillOwn>true</StillOwn>
      <VIN>sample string 6</VIN>
      <WorkPhone>sample string 2</WorkPhone>
    </Entity>
    <Entity>
      <Kind>sample string 8</Kind>
      <EntityID>526922ae-1ca3-4a8c-b8f4-f616345a95d5</EntityID>
      <FullName>sample string 7</FullName>
      <IsAlert>true</IsAlert>
      <IsContractEnd>true</IsContractEnd>
      <IsCreditConvert>true</IsCreditConvert>
      <IsEngagedAlert>true</IsEngagedAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsInMarketAlert>true</IsInMarketAlert>
      <IsMileageAlert>true</IsMileageAlert>
      <IsServiceAlert>true</IsServiceAlert>
      <IsServiceApptAlert>true</IsServiceApptAlert>
      <IsWarrantyAlert>true</IsWarrantyAlert>
      <TrimID>1</TrimID>
      <CellPhone>sample string 3</CellPhone>
      <Email>sample string 4</Email>
      <HomePhone>sample string 1</HomePhone>
      <StillOwn>true</StillOwn>
      <VIN>sample string 6</VIN>
      <WorkPhone>sample string 2</WorkPhone>
    </Entity>
  </Entities>
</EntitiesList>