Entity Services

Overview

Xchecker can be configures with multiple entity indexes from different sources. For vehicles and motorcycles, Halfords uses the Haynes Pro index (formally CarWeb) and for Cycles it will be using a Halfords custom index. This API exposes all the configured Xchecker indexes; that is, those configured to be copied to the IDL.

The items in these indexes are referred to as entities and are referenced and retrieved by primary ordinal keys. Currently, we allow up to 7 primary ordinals that are configured by Elcome in consultation with Halfords, such as:

1. Make
2. Model
3. Year
4. Body
5. Engine
6. Series

All entities in Xchecker have a unique internal identifier, which is returned with any entity request. This internal reference is then used for subsequent API method calls when an entity filter is required.

Cascade and Sparse

The entity retrieval cascade method calls require that you step through the primary ordinals providing a growing list of previous user selections. It is intended that these will mainly be used in cascading drop downs for manual entity selection. It is important that you do not change the data used for previous selection in any way as this may cause the latter calls to fail.

The sparse calls allow you to miss primary ordinals for cases where you may want to do an entity lookup such as, all Audi 5.0 litre cars.

Summary List

• getEntityIndexes

  Returns a list of the indexes originally held in Xchecker along with the key primary ordinal fields and associated secondary attributes. There may be multiple indexes configured, it is your responsibility to select the correct one for your needs. You must use the indexReference value returned by this call in all subsequent entity methods.

• getVehicleByVRM

  Returns the VRM lookup details.

• getPrimaryEntityValuesByCascadingPrimaries

  This method is for when you are populating cascading drop down boxes for manual entity selection. You step through each of the primary ordinals getting unique values and using the selected value in the next call to this method with the next primary ordinal.

• getPrimaryEntityValuesBySparsePrimaries [Deprecated]

  This method returns distinct lists of primary ordinal values allowing for missing values. It would be used when making ad-hoc queries for entities.

• getEntitiesByCascadingPrimaries

  This method is for when you are retrieving full entity details following a cascading manual selection process.

• getEntitiesBySparsePrimaries [Deprecated]

  This method is for when you are retrieving full entity details following a sparse manual selection process.

• getEntitiesByExternalReferences

  This method returns full entity details given a list of external references. These external references will depend upon the index selected. Currently these are CarWebID's for all non cycle entities.

• getEntitiesByInternalReferences

  This method returns full entity details given a list of internal entity references.

• getAbbreviatedEntitiesByPartNumber [Deprecated]

  Returns an abbreviated list of entities where the part given by the part number is applicated.

• getAbbreviatedEntitiesBySAPArticleReference [Deprecated]

  Returns an abbreviated list of entities where the part given by the SAP Article ID is applicated.

---

getEntityIndexes

Method URL

/v2/entity/getEntityIndexes

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

simpleRequest

public class simpleRequest
{
    public baseRequest { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    }
}

Response Structure

entityIndexResponse

public class entityIndexResponse
{
    public baseResponse baseResponse { get; set; }
    public List<index> indexes{ get; set; }
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T12:53:18.777Z",
      "system": "string"
    },
    "responseTime": "00:00:01.7031268",
    "resultCode": 0,
    "resultText": "success"
  },
  "indexes": [
    {
      "indexReference": 6,
      "name": "pcandlcv",
      "typeName": "Car",
      "provider": "Custom",
      "primaryAttributesCount": 6,
      "secondaryAttributesCount": 39,
      "primaryAttributes": [
        {
          "ordinal": 1,
          "name": "make"
        },
        {
          "ordinal": 2,
          "name": "model"
        },
        {
          "ordinal": 3,
          "name": "datefrom"
        },
        {
          "ordinal": 4,
          "name": "nomcc"
        },
        {
          "ordinal": 5,
          "name": "fueltype"
        },
        {
          "ordinal": 6,
          "name": "bodytype"
        }
      ],
      "secondaryAttributes": [
        {
          "ordinal": 3,
          "name": "VehicleType"
        },
        {
          "ordinal": 4,
          "name": "Range Series"
        },
        {
          "ordinal": 6,
          "name": "Variant"
        },
        {
          "ordinal": 7,
          "name": "Vehicle Category Description"
        },
        {
          "ordinal": 8,
          "name": "ExactEngineSize"
        },
        {
          "ordinal": 9,
          "name": "KW"
        },
        {
          "ordinal": 10,
          "name": "BHP"
        },
        {
          "ordinal": 11,
          "name": "NumberOfDoors"
        },
        {
          "ordinal": 14,
          "name": "DateTo"
        },
        {
          "ordinal": 15,
          "name": "Transmission"
        },
        {
          "ordinal": 17,
          "name": "Intro Date"
        },
        {
          "ordinal": 18,
          "name": "EngineAspiration"
        },
        {
          "ordinal": 19,
          "name": "DriveType"
        },
        {
          "ordinal": 20,
          "name": "Driving Axle"
        },
        {
          "ordinal": 21,
          "name": "Forward Gears"
        },
        {
          "ordinal": 22,
          "name": "Seats"
        },
        {
          "ordinal": 23,
          "name": "Engine Model"
        },
        {
          "ordinal": 24,
          "name": "EngineCylinderLayout"
        },
        {
          "ordinal": 25,
          "name": "Fuel Delivery"
        },
        {
          "ordinal": 26,
          "name": "No Cylinders"
        },
        {
          "ordinal": 27,
          "name": "Valves Per Cylinder"
        },
        {
          "ordinal": 28,
          "name": "Valve Gear"
        },
        {
          "ordinal": 29,
          "name": "Length"
        },
        {
          "ordinal": 30,
          "name": "Width"
        },
        {
          "ordinal": 31,
          "name": "Height"
        },
        {
          "ordinal": 32,
          "name": "AirConditioning"
        },
        {
          "ordinal": 33,
          "name": "PowerSteering"
        },
        {
          "ordinal": 34,
          "name": "ABS"
        },
        {
          "ordinal": 35,
          "name": "Population"
        },
        {
          "ordinal": 36,
          "name": "Subset"
        },
        {
          "ordinal": 37,
          "name": "MAMv8"
        },
        {
          "ordinal": 38,
          "name": "MAMv7"
        },
        {
          "ordinal": 39,
          "name": "Engine Sump Capacity"
        },
        {
          "ordinal": 40,
          "name": "Brake Fluid Capacity"
        },
        {
          "ordinal": 41,
          "name": "Transmission Fluid Capacity"
        },
        {
          "ordinal": 42,
          "name": "Coolant Capacity"
        },
        {
          "ordinal": 43,
          "name": "Subset Body"
        },
        {
          "ordinal": 44,
          "name": "commercial"
        },
        {
          "ordinal": 45,
          "name": "Hydraulic Capacity"
        }
      ]
    },
    {
      "indexReference": 7,
      "name": "motorcycle",
      "typeName": "Motorcycle",
      "provider": "Custom",
      "primaryAttributesCount": 6,
      "secondaryAttributesCount": 9,
      "primaryAttributes": [
        {
          "ordinal": 1,
          "name": "make"
        },
        {
          "ordinal": 2,
          "name": "model"
        },
        {
          "ordinal": 3,
          "name": "datefrom"
        },
        {
          "ordinal": 4,
          "name": "exactenginesize"
        },
        {
          "ordinal": 5,
          "name": "fueltype"
        },
        {
          "ordinal": 6,
          "name": "mctype"
        }
      ],
      "secondaryAttributes": [
        {
          "ordinal": 3,
          "name": "VehicleType"
        },
        {
          "ordinal": 4,
          "name": "Vehicle Category Description"
        },
        {
          "ordinal": 5,
          "name": "Variant"
        },
        {
          "ordinal": 8,
          "name": "Population"
        },
        {
          "ordinal": 9,
          "name": "Subset"
        },
        {
          "ordinal": 10,
          "name": "Intro Date"
        },
        {
          "ordinal": 14,
          "name": "DateTo"
        },
        {
          "ordinal": 15,
          "name": "Subset Body"
        },
        {
          "ordinal": 16,
          "name": "commercial"
        }
      ]
    },
    {
      "indexReference": 8,
      "name": "cycles",
      "typeName": "Cycle",
      "provider": "Custom",
      "primaryAttributesCount": 5,
      "secondaryAttributesCount": 9,
      "primaryAttributes": [
        {
          "ordinal": 1,
          "name": "manufacturer"
        },
        {
          "ordinal": 2,
          "name": "model"
        },
        {
          "ordinal": 3,
          "name": "gender"
        },
        {
          "ordinal": 4,
          "name": "variant"
        },
        {
          "ordinal": 5,
          "name": "startmy"
        }
      ],
      "secondaryAttributes": [
        {
          "ordinal": 3,
          "name": "VehType"
        },
        {
          "ordinal": 4,
          "name": "Type"
        },
        {
          "ordinal": 6,
          "name": "Model Year"
        },
        {
          "ordinal": 8,
          "name": "Subset Number"
        },
        {
          "ordinal": 9,
          "name": "Subset Name"
        },
        {
          "ordinal": 10,
          "name": "Frame"
        },
        {
          "ordinal": 11,
          "name": "Wheel"
        },
        {
          "ordinal": 12,
          "name": "Colour"
        },
        {
          "ordinal": 14,
          "name": "EndMY"
        }
      ]
    }
  ]
}

---

getVehicleByVRM

Method URL

/v2/entity/getVehicleByVRM

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

vrmVehicleLookupRequest

public class vrmVehicleLookupRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public string vrm { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference must be supplied
vrm	no	The vehicle registration mark must be supplied

Body Example

{
  "baseRequest": {
    "requestReference": 0,
    "requestPostedTime": "2018-11-13T10:09:11.574Z",
    "system": "string"
  },
  "indexReference": 6,
  "vrm": "MYREG"
}

Response Structure

entityResponse

public class entityResponse
{
    public baseResponse baseResponse { get; set; } = new baseResponse();
    public List<indexEntity> entities { get; set; } = new List<indexEntity>();
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

indexEntity

public class indexEntity
{
    public long indexReference { get; set; }
    public string provider { get; set; }
    public long internalReference { get; set; }
    public string externalReference { get; set; }
    public Dictionary<string, string> attributes { get; set; } 
    public Dictionary<string, string> vrmAttributes { get; set; } 
}

Response Example

{
  "baseResponse": {
    "baseRequest": null,
    "responseTime": "00:00:00.4479024",
    "resultCode": 0,
    "resultText": "success"
  },
  "entities": [
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 161958,
      "externalReference": "28084",
      "attributes": {
        "make": "MERCEDES",
        "model": "C-CLASS",
        "datefrom": "05/2004 -> 12/2007",
        "nomcc": "2.1",
        "fueltype": "Diesel",
        "bodytype": "ESTATE",
        "vehicletype": "PC and LCV",
        "rangeseries": "S203 (FL)",
        "variant": "C220 CDI AVANTGARDE SE",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "2148",
        "kw": "110",
        "bhp": "147.5",
        "numberofdoors": "5",
        "dateto": "12/2007",
        "transmission": "AUTOMATIC",
        "introdate": "01/05/2004",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "REAR",
        "forwardgears": "5",
        "seats": "5",
        "enginemodel": "OM646.963",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": "Fuel Injection",
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4541",
        "width": "1977",
        "height": "1466",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "2568",
        "subset": "031003180",
        "mamv8": "113748",
        "mamv7": "14302160159004",
        "enginesumpcapacity": "6.5",
        "brakefluidcapacity": "2",
        "transmissionfluidcapacity": "7.5",
        "coolantcapacity": "8.5",
        "subsetbody": "031003040",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {
        "aspiration": "TURBO CHARGED",
        "bodyStyle": " ESTATE",
        "bodyStyleDescription": "ESTATE",
        "colourOriginal": "SILVER",
        "combined_EngineCapacity": "2148",
        "combined_ForwardGears": "5",
        "combined_Make": "MERCEDES",
        "combined_Model": "C-CLASS C220 CDI AVANTGARDE SE",
        "combined_Transmission": "AUTOMATIC",
        "combined_VIN": "WDB2032082F876021",
        "countryOfOrigin": "GERMANY",
        "dateFirstRegistered": "2006-10-09",
        "dateOfManufacture": "2006-10-09",
        "delivery": "FUEL INJECTION",
        "driveAxle": "REAR",
        "driveType": "4X2",
        "dvlaForwardGears": "",
        "dvlaTransmission": "",
        "dvlA_WheelPlanDesc": "2-AXLE-RIGID BODY",
        "engineCapacity": "2148",
        "engineManufacturer": "MERCEDES-BENZ",
        "engineModelCode": "OM646.963",
        "engineNumber": "64696330583081",
        "forwardGears": "5",
        "fuelType": "DIESEL",
        "importMarker": "false",
        "kerbWeightMin": "1455",
        "lengthMM": "4541",
        "manufacturerBuildDate": "",
        "maximumPowerBHP": "147.5",
        "maximumPowerInKW": "110",
        "modelRangeDescription": "C-CLASS",
        "modelSeries": "S203 (FL)",
        "modelVariantDescription": "C220 CDI AVANTGARDE SE",
        "mvriS_MakeCode": "M2",
        "mvriS_ModelCode": "DNX",
        "numberOfCylinders": "4",
        "numberOfDoors": "5",
        "numberOfValvesPerCylinder": "4",
        "transmission": "AUTOMATIC",
        "unladenWeightForVans": "",
        "valveGear": "DOHC",
        "vehicleImageUrl": "/VehicleImages/54934.jpg",
        "vrM_Curr": "KP56FJX",
        "wheelbaseForVans": ""
      }
    }
  ]
}

---

getPrimaryEntityValuesByCascadingPrimaries

Method URL

/v2/entity/getPrimaryEntityValuesByCascadingPrimaries

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

manualEntityLookupRequestByPrimaries

public class manualEntityLookupRequestByPrimaries
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
requestedPrimary	no	The primary ordinal you want values for
primaryValues	no	The previous primary selections

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference":6,
    "requestedPrimary":1,
    "primaryValues": ["","","","","",""]
}

Response Structure

manualEntityValueResponse

public class manualEntityValueResponse
{
    public baseResponse baseResponse { get; set; }
    public List<string> response{ get; set; }
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T12:55:45.423Z",
      "system": "string"
    },
    "responseTime": "00:00:00.0706302",
    "resultCode": 0,
    "resultText": "success"
  },
  "response": [
    "ABARTH",
    "AC",
    "ACURA",
    "AIXAM",
    "ALFA ROMEO",
    "ALPINE",
    "ARIEL",
    "ARMSTRONG SIDDELEY",
    "ARO",
    "ASIA",
    "ASTON MARTIN",
    "AUDI",
    "AUSTIN",
    "AUTO-SLEEPERS",
    "AUTO-TRAIL",
    "BEDFORD",
    "BENTLEY",
    "BINZ",
    "BITTER",
    "BMW",
    "BOND",
    "BREMACH",
    "BRISTOL",
    "BUGATTI",
    "CADILLAC",
    "CARBODIES",
    "CATERHAM",
    "CHAUSSON",
    "CHEVROLET",
    "CHRYSLER",
    "CITROEN",
    "CLASSIC REPLICAS",
    "COLEMAN MILNE",
    "COLT",
    "CORVETTE",
    "DACIA",
    "DAEWOO",
    "DAF",
    "DAIHATSU",
    "DAIMLER",
    "DATSUN",
    "DE TOMASO",
    "DETHLEFFS",
    "DFSK",
    "DODGE",
    "DODGE/COMMER",
    "DODGE/COMMER/KARRIER",
    "DONG FENG",
    "DS",
    "DUFFY",
    "EAGLE",
    "EFFEDI",
    "EUROMEC",
    "FERRARI",
    "FIAT",
    "FORD",
    "FORD USA",
    "FREIGHT ROVER",
    "FSO",
    "GENERAL MOTORS",
    "GINETTA",
    "GLAS",
    "GOUPIL",
    "GREAT WALL",
    "HILLMAN",
    "HOLDEN",
    "HONDA",
    "HUMBER",
    "HUMMER",
    "HYMER",
    "HYUNDAI",
    "INFINITI",
    "ISUZU",
    "ISUZU TRUCKS",
    "IVECO",
    "JAGUAR",
    "JEEP",
    "JENSEN",
    "KAMA",
    "KIA",
    "LADA",
    "LAMBORGHINI",
    "LANCIA",
    "LAND ROVER",
    "LDV",
    "LEXUS",
    "LIGIER",
    "LINCOLN",
    "LONDON TAXIS INT",
    "LONSDALE",
    "LOTUS",
    "MAHINDRA",
    "MAN",
    "MASERATI",
    "MAYBACH",
    "MAZDA",
    "MCLAREN",
    "MCW",
    "MERCEDES",
    "METROCAB",
    "MG",
    "MG XPOWER",
    "MIA",
    "MICROCAR",
    "MINI",
    "MITSUBISHI",
    "MITSUBISHI FUSO",
    "MORGAN",
    "MORRIS",
    "MOSKVICH",
    "NISSAN",
    "NOBLE",
    "NSU",
    "OLDSMOBILE",
    "OPEL",
    "OSCA",
    "PAGANI",
    "PANTHER",
    "PARRADINE",
    "PERODUA",
    "PEUGEOT",
    "PIAGGIO",
    "POLSKI-FIAT",
    "PONTIAC",
    "PORSCHE",
    "PORTARO",
    "PROTON",
    "QT",
    "QVALE",
    "RELIANT",
    "RENAULT",
    "RENAULT TRUCKS",
    "RILEY",
    "ROEWE",
    "ROLLS ROYCE",
    "ROVER",
    "SAAB",
    "SAN",
    "SAO",
    "SCION",
    "SEAT",
    "SECMA",
    "SIMCA",
    "SINGER",
    "SKODA",
    "SMART",
    "SPECTRE",
    "SSANGYONG",
    "STANDARD",
    "SUBARU",
    "SUNBEAM",
    "SUZUKI",
    "TALBOT",
    "TATA",
    "TAZZARI",
    "TESLA",
    "THINK",
    "TORNADO",
    "TOYOTA",
    "TRIUMPH",
    "TVR",
    "UNSPECIFIED",
    "VANDEN PLAS",
    "VAUXHALL",
    "VOLGA",
    "VOLKSWAGEN",
    "VOLVO",
    "WARTBURG",
    "WIESMANN",
    "WOLSELEY",
    "ZASTAVA"
  ]
}

---

getPrimaryEntityValuesBySparsePrimaries

Method URL

/v2/entity/getPrimaryEntityValuesBySparsePrimaries

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

manualEntityLookupRequestByPrimaries

public class manualEntityLookupRequestByPrimaries
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
requestedPrimary	no	The primary ordinal you want values for (from getEntityIndexes)
primaryValues	no	The previous primary selections

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference":6,
    "requestedPrimary":4,
    "primaryValues": ["AUDI","","","","",""]
}

Response Structure

manualEntityValueResponse

public class manualEntityValueResponse
{
    public baseResponse baseResponse { get; set; }
    public List<string> response{ get; set; }
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T12:57:04.591Z",
      "system": "string"
    },
    "responseTime": "00:00:01.1383611",
    "resultCode": 0,
    "resultText": "success"
  },
  "response": [
    "",
    "1.0",
    "1.2",
    "1.3",
    "1.4",
    "1.5",
    "1.6",
    "1.7",
    "1.8",
    "1.9",
    "2.0",
    "2.1",
    "2.2",
    "2.3",
    "2.4",
    "2.5",
    "2.6",
    "2.7",
    "2.8",
    "2.9",
    "3.0",
    "3.1",
    "3.2",
    "3.6",
    "3.7",
    "3.9",
    "4.0",
    "4.1",
    "4.2",
    "5.0",
    "5.2",
    "6.0",
    "6.3"
  ]
}

---

getEntitiesByCascadingPrimaries

Method URL

/v2/entity/getEntitiesByCascadingPrimaries

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

manualEntityLookupRequestByPrimaries

public class manualEntityLookupRequestByPrimaries
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
requestedPrimary	no	The primary ordinal you want entities for (from getEntityIndexes)
primaryValues	no	The previous primary selections

Body Example

{
  "baseRequest": {
    "requestReference": 123456,
    "requestPostedTime": "2019-05-28T12:58:36.525Z",
    "system": "ecat"
  },
  "indexReference": 6,
  "requestedPrimary": 6,
  "primaryValues": [
    "AUDI","A4","01/2011 -> 12/2015","2.0","PETROL","SALOON"
  ]
}

Response Structure

entityResponse

public class entityResponse
{
    public baseResponse baseResponse { get; set; }
    public List<indexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

indexEntity

public class indexEntity
{
    public long indexReference  { get; set; }
    public string provider { get; set; }
    public long internalReference { get; set; }
    public string externalReference { get; set; }
    public Dictionary<string, string> attributes { get; set; } 
    [Not used in this method]
    public Dictionary<string, string> vrmAttributes { get; set; } 
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 123456,
      "requestPostedTime": "2019-05-28T12:58:36.525Z",
      "system": "ecat"
    },
    "responseTime": "00:00:00.7720491",
    "resultCode": 0,
    "resultText": "success"
  },
  "entities": [
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 145830,
      "externalReference": "127042",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "77",
        "subset": "011006200",
        "mamv8": "101532",
        "mamv7": "10501310000132",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 171031,
      "externalReference": "127044",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "13",
        "subset": "011006200",
        "mamv8": "",
        "mamv7": "10501310000130",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "8",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 206254,
      "externalReference": "127043",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "61",
        "subset": "011006200",
        "mamv8": "101527",
        "mamv7": "10501310000130",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "8",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 221789,
      "externalReference": "127045",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "7",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "51",
        "subset": "011006200",
        "mamv8": "101597",
        "mamv7": "10501310000167",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    }
  ]
}

---

getEntitiesBySparsePrimaries

Method URL

/v2/entity/getEntitiesBySparsePrimaries

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

manualEntityLookupRequestByPrimaries

public class manualEntityLookupRequestByPrimaries
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
requestedPrimary	no	The primary ordinal you want entities for (from getEntityIndexes)
primaryValues	no	The previous primary selections

Body Example

{
  "baseRequest": {
    "requestReference": 0,
    "requestPostedTime": "2019-05-28T13:10:49.351Z",
    "system": "ecat"
  },
  "indexReference": 6,
  "requestedPrimary": 6,
  "primaryValues": [
    "AUDI","A4","01/2011 -> 12/2015","2.0","","SALOON"
  ]
}

Response Structure

entityResponse

public class entityResponse
{
    public baseResponse baseResponse { get; set; }
    public List<indexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

indexEntity

public class indexEntity
{
    public long indexReference  { get; set; }
    public string provider { get; set; }
    public long internalReference { get; set; }
    public string externalReference { get; set; }
    public Dictionary<string, string> attributes { get; set; } 
    [Not used in this method]
    public Dictionary<string, string> vrmAttributes 
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T13:10:49.351Z",
      "system": "ecat"
    },
    "responseTime": "00:00:00.8176264",
    "resultCode": 0,
    "resultText": "success"
  },
  "entities": [
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 145830,
      "externalReference": "127042",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "77",
        "subset": "011006200",
        "mamv8": "101532",
        "mamv7": "10501310000132",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 157577,
      "externalReference": "127050",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "Diesel",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TDI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1968",
        "kw": "106",
        "bhp": "141",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "CVT",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "8",
        "seats": "5",
        "enginemodel": "CAGA",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "282",
        "subset": "011006170",
        "mamv8": "101570",
        "mamv7": "10501310000157",
        "enginesumpcapacity": null,
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "8",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 171031,
      "externalReference": "127044",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "13",
        "subset": "011006200",
        "mamv8": "",
        "mamv7": "10501310000130",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "8",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 194812,
      "externalReference": "127052",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "Diesel",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TDI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1968",
        "kw": "126",
        "bhp": "168",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CAHA",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "274",
        "subset": "011006170",
        "mamv8": "101539",
        "mamv7": "10501310000137",
        "enginesumpcapacity": null,
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "4.5",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 206254,
      "externalReference": "127043",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "61",
        "subset": "011006200",
        "mamv8": "101527",
        "mamv7": "10501310000130",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "8",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 212727,
      "externalReference": "127051",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "Diesel",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TDI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1968",
        "kw": "126",
        "bhp": "168",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CAHA",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "340",
        "subset": "011006170",
        "mamv8": "101538",
        "mamv7": "10501310000136",
        "enginesumpcapacity": null,
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "4.3",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 221789,
      "externalReference": "127045",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "7",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "51",
        "subset": "011006200",
        "mamv8": "101597",
        "mamv7": "10501310000167",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    }
  ]
}

---

getEntitiesByExternalReferences

Method URL

/v2/entity/getEntitiesByExternalReferences

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

referencedEntityLookupRequestString

public class referencedEntityLookupRequestString
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public List<string> references { get; set; } 
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
references	no	List of external references (dependant upon index)

Body Example

{
  "baseRequest": {
    "requestReference": 0,
    "requestPostedTime": "2019-05-28T13:14:43.138Z",
    "system": "ecat"
  },
  "indexReference": 6,
  "references": [
    "127045","127051"
  ]
}

Response Structure

entityResponse

public class entityResponse
{
    public baseResponse baseResponse { get; set; }
    public List<indexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

indexEntity

public class indexEntity
{
    public long indexReference  { get; set; }
    public string provider { get; set; }
    public long internalReference { get; set; }
    public string externalReference { get; set; }
    public Dictionary<string, string> attributes { get; set; } 
    [Not used in this method]
    public Dictionary<string, string> vrmAttributes { get; set; } 
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T13:14:43.138Z",
      "system": "ecat"
    },
    "responseTime": "00:00:00.0935014",
    "resultCode": 0,
    "resultText": "success"
  },
  "entities": [
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 221789,
      "externalReference": "127045",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "7",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "51",
        "subset": "011006200",
        "mamv8": "101597",
        "mamv7": "10501310000167",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 212727,
      "externalReference": "127051",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "Diesel",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TDI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1968",
        "kw": "126",
        "bhp": "168",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CAHA",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "340",
        "subset": "011006170",
        "mamv8": "101538",
        "mamv7": "10501310000136",
        "enginesumpcapacity": null,
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "4.3",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    }
  ]
}

---

getEntitiesByInternalReferences

Method URL

/v2/entity/getEntitiesByInternalReferences

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

referencedEntityLookupRequestNumeric

public class referencedEntityLookupRequestNumeric
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public List<long> references { get; set; } 
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
references	no	One or many internal entity references

Body Example

{
  "baseRequest": {
    "requestReference": 0,
    "requestPostedTime": "2019-05-28T13:16:07.595Z",
    "system": "ecat"
  },
  "indexReference": 6,
  "references": [
    212727,221789
  ]
}

Response Structure

entityResponse

public class entityResponse
{
    public baseResponse baseResponse { get; set; }
    public List<indexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

indexEntity

public class indexEntity
{
    public long indexReference  { get; set; }
    public string provider { get; set; }
    public long internalReference { get; set; }
    public string externalReference { get; set; }
    public Dictionary<string, string> attributes { get; set; } 
    [Not used in this method]
    public Dictionary<string, string> vrmAttributes { get; set; } 
}

Response Example

{
  "baseResponse": {
    "baseRequest": {
      "requestReference": 0,
      "requestPostedTime": "2019-05-28T13:16:07.595Z",
      "system": "ecat"
    },
    "responseTime": "00:00:00.0440042",
    "resultCode": 0,
    "resultText": "success"
  },
  "entities": [
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 212727,
      "externalReference": "127051",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "Diesel",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TDI S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1968",
        "kw": "126",
        "bhp": "168",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "MANUAL",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X2",
        "drivingaxle": "FRONT",
        "forwardgears": "6",
        "seats": "5",
        "enginemodel": "CAHA",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "340",
        "subset": "011006170",
        "mamv8": "101538",
        "mamv7": "10501310000136",
        "enginesumpcapacity": null,
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "4.3",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    },
    {
      "indexReference": 6,
      "provider": "Custom",
      "internalReference": 221789,
      "externalReference": "127045",
      "attributes": {
        "make": "AUDI",
        "model": "A4",
        "datefrom": "01/2011 -> 12/2015",
        "nomcc": "2.0",
        "fueltype": "PETROL",
        "bodytype": "SALOON",
        "vehicletype": "PC and LCV",
        "rangeseries": "MK4 (8K) (B8)",
        "variant": "TFSI QUATTRO S LINE BLACK EDITION",
        "vehiclecategorydescription": "CARS (exc. Off-Road)",
        "exactenginesize": "1984",
        "kw": "156",
        "bhp": "208",
        "numberofdoors": "4",
        "dateto": "12/2015",
        "transmission": "AUTOMATIC",
        "introdate": "04/01/2011",
        "engineaspiration": "Turbocharged",
        "drivetype": "4X4",
        "drivingaxle": "ALL - PERMANENT",
        "forwardgears": "7",
        "seats": "5",
        "enginemodel": "CDNC",
        "enginecylinderlayout": "IN LINE",
        "fueldelivery": null,
        "nocylinders": "4",
        "valvespercylinder": "4",
        "valvegear": "DOHC",
        "length": "4703",
        "width": "1826",
        "height": "1427",
        "airconditioning": "AC",
        "powersteering": "PS",
        "abs": "ABS",
        "population": "51",
        "subset": "011006200",
        "mamv8": "101597",
        "mamv7": "10501310000167",
        "enginesumpcapacity": "4.6",
        "brakefluidcapacity": null,
        "transmissionfluidcapacity": "9",
        "coolantcapacity": null,
        "subsetbody": "011006020",
        "commercial": "n",
        "hydrauliccapacity": null
      },
      "vrmAttributes": {}
    }
  ]
}

---

getAbbreviatedEntitiesByPartNumber

Please note that this call could return a lot of data.

Method URL

/v2/entity/getAbbreviatedEntitiesByPartNumber

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

partNumberEntityLookupRequest

public class partNumberEntityLookupRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string brand { get; set; }
    public string externalNode { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
partNumber	no	Full part number
externalReference
brand
externalNode	no	The external node identifier
requestedPrimary	no	The primary ordinal depth we will be returning entities for - must be at least 1
primaryValues	no	The ordinal values dependant upon ordinal depth request

Body Example

Response Structure

abbreviatedEntityResponse

public class abbreviatedEntityResponse
{
    public baseResponse baseResponse { get; set; } 
    public List<abbreviatedIndexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

abbreviatedIndexEntity

public class abbreviatedIndexEntity
{
    public long internalReference { get; set; }
    public List<string> attributes { get; set; } 
}

Response Example (shortened for expedience)

---

getAbbreviatedEntitiesBySAPArticleReference

Please note that this call could return a lot of data.

Method URL

/v2/entity/getAbbreviatedEntitiesBySAPArticleReference

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

partNumberEntityLookupRequest

public class partNumberEntityLookupRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string brand { get; set; }
    public string externalNode { get; set; }
    public long requestedPrimary { get; set; }
    public List<string> primaryValues { get; set; }
}

baseRequest

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; }
    public string system { get; set; }
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	Reference to the index for which entries will be returned
partNumber
externalReference	no	The SAP Article ID
brand
externalNode	no	The external node identifier
requestedPrimary	no	The primary ordinal depth we will be returning data for - must be at least 1
primaryValues	no	The ordinal values dependant upon ordinal depth request

Body Example

Response Structure

abbreviatedEntityResponse

public class abbreviatedEntityResponse
{
    public baseResponse baseResponse { get; set; } 
    public List<abbreviatedIndexEntity> entities { get; set; } 
}

baseResponse

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

abbreviatedIndexEntity

public class abbreviatedIndexEntity
{
    public long internalReference { get; set; }
    public List<string> attributes { get; set; } 
}

Response Example (shortened for expedience)

---