POST ShortTerm/GetTransunionVehicleData

Request Information

URI Parameters

None.

Body Parameters

VehicleRequest
NameDescriptionTypeAdditional information
VehicleId

integer

None.

SecurityKey

string

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "VehicleId": 1,
  "SecurityKey": "sample string 2",
  "PolicyId": 3
}

application/xml, text/xml

Sample:
<VehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>3</PolicyId>
  <SecurityKey>sample string 2</SecurityKey>
  <VehicleId>1</VehicleId>
</VehicleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfTransunionVehicleData
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

TransunionVehicleData

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "VehicleId": 1,
    "PolicyId": 2,
    "ModelId": 3,
    "Make": "sample string 4",
    "Model": "sample string 5",
    "MMCode": "sample string 6",
    "ManufactureYear": 7,
    "ColorId": 8,
    "VehicleCondition": "sample string 9",
    "VehicleMileage": 10,
    "SumInsured": 11.0,
    "VehicleIdentificationNumber": "sample string 12",
    "EngineNumber": "sample string 13",
    "RegistrationNumber": "sample string 14",
    "FinanceHouse": "sample string 15"
  }
}

application/xml, text/xml

Sample:
<ResponseOfTransunionVehicleDatalP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:ColorId>8</d2p1:ColorId>
    <d2p1:EngineNumber>sample string 13</d2p1:EngineNumber>
    <d2p1:FinanceHouse>sample string 15</d2p1:FinanceHouse>
    <d2p1:MMCode>sample string 6</d2p1:MMCode>
    <d2p1:Make>sample string 4</d2p1:Make>
    <d2p1:ManufactureYear>7</d2p1:ManufactureYear>
    <d2p1:Model>sample string 5</d2p1:Model>
    <d2p1:ModelId>3</d2p1:ModelId>
    <d2p1:PolicyId>2</d2p1:PolicyId>
    <d2p1:RegistrationNumber>sample string 14</d2p1:RegistrationNumber>
    <d2p1:SumInsured>11</d2p1:SumInsured>
    <d2p1:VehicleCondition>sample string 9</d2p1:VehicleCondition>
    <d2p1:VehicleId>1</d2p1:VehicleId>
    <d2p1:VehicleIdentificationNumber>sample string 12</d2p1:VehicleIdentificationNumber>
    <d2p1:VehicleMileage>10</d2p1:VehicleMileage>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfTransunionVehicleDatalP_S41WJs>