POST Entity/getallentities

Get a list of all entities filtered by FromDateUTC.

Request Information

URI Parameters

None.

Body Parameters

GetAllEntitiesRequest
NameDescriptionTypeAdditional information
fromDateUTC

UTC Date/time to filter requests. This date is compared with the EntityInsertDate.

date

Required

rowLimit

Maximum number of rows to return. Returns first N rows since fromDateUTC. Set value to 0 to returrn all rows.

integer

Required

lastEntityID

Last EntityID returned in the previous call. For the initial call this should be set to an empty GUID: '00000000-0000-0000-0000-000000000000'. If setting a rowLimit this property must be set to a proper EntityID (either last or empty). If not using rowLimit (rowLimit = 0) this should be set to an empty GUID.

globally unique identifier

Required

token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "fromDateUTC": "2024-07-16T06:10:31.7970996-07:00",
  "rowLimit": 2,
  "lastEntityID": "ad436afb-efaa-43cc-8357-8cbcf30a3322",
  "token": "2c11a617-20b0-4d56-a56a-9f28a927024b"
}

application/xml, text/xml

Sample:
<GetAllEntitiesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Entity">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">2c11a617-20b0-4d56-a56a-9f28a927024b</token>
  <fromDateUTC>2024-07-16T06:10:31.7970996-07:00</fromDateUTC>
  <lastEntityID>ad436afb-efaa-43cc-8357-8cbcf30a3322</lastEntityID>
  <rowLimit>2</rowLimit>
</GetAllEntitiesRequest>

Response Information

Resource Description

GetAllEntitiesResponse
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

EntityList

Entity list

Collection of EntityItem

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityList": [
    {
      "EntityID": "15915667-0d15-4f03-8b8f-716720f2a947",
      "EntityInsertDate": "2024-07-16T06:10:31.8000796-07:00",
      "CustomerID": 3,
      "VehicleID": 4,
      "VIN": "sample string 5",
      "SaleRODate": "2024-07-16T06:10:31.8000796-07:00",
      "IsConquest": true,
      "VHash": "sample string 8",
      "DMSDealID": "sample string 9"
    },
    {
      "EntityID": "15915667-0d15-4f03-8b8f-716720f2a947",
      "EntityInsertDate": "2024-07-16T06:10:31.8000796-07:00",
      "CustomerID": 3,
      "VehicleID": 4,
      "VIN": "sample string 5",
      "SaleRODate": "2024-07-16T06:10:31.8000796-07:00",
      "IsConquest": true,
      "VHash": "sample string 8",
      "DMSDealID": "sample string 9"
    }
  ],
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<GetAllEntitiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Entity">
  <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>
  <EntityList>
    <EntityItem>
      <CustomerID>3</CustomerID>
      <DMSDealID>sample string 9</DMSDealID>
      <EntityID>15915667-0d15-4f03-8b8f-716720f2a947</EntityID>
      <EntityInsertDate>2024-07-16T06:10:31.8000796-07:00</EntityInsertDate>
      <IsConquest>true</IsConquest>
      <SaleRODate>2024-07-16T06:10:31.8000796-07:00</SaleRODate>
      <VHash>sample string 8</VHash>
      <VIN>sample string 5</VIN>
      <VehicleID>4</VehicleID>
    </EntityItem>
    <EntityItem>
      <CustomerID>3</CustomerID>
      <DMSDealID>sample string 9</DMSDealID>
      <EntityID>15915667-0d15-4f03-8b8f-716720f2a947</EntityID>
      <EntityInsertDate>2024-07-16T06:10:31.8000796-07:00</EntityInsertDate>
      <IsConquest>true</IsConquest>
      <SaleRODate>2024-07-16T06:10:31.8000796-07:00</SaleRODate>
      <VHash>sample string 8</VHash>
      <VIN>sample string 5</VIN>
      <VehicleID>4</VehicleID>
    </EntityItem>
  </EntityList>
</GetAllEntitiesResponse>