POST ShortTerm/GetAdditionalVehicleFields

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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

ResponseOfAdditionalVehicleFields

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	AdditionalVehicleFields	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "Id": 1,
    "CreatedDateTime": "2025-05-13T21:37:37.4257156+02:00",
    "CreatedBy": "sample string 3",
    "VehicleId": 4,
    "LastCoverDate": "2025-05-13T21:37:37.4257156+02:00",
    "PreviousInsurerId": 6,
    "IsTravelToRuralAreas": true,
    "TravelOnDirtRoadsId": 8,
    "Mileage": 9,
    "VehicleCondition": "sample string 10",
    "LicenseAge": 11,
    "AverageMileagePerMonth": 12,
    "IsSasriaSelected": true
  }
}

application/xml, text/xml

Sample:

<ResponseOfAdditionalVehicleFields_PYwLh37g 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.GeneratedModels">
    <d2p1:AverageMileagePerMonth>12</d2p1:AverageMileagePerMonth>
    <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
    <d2p1:CreatedDateTime>2025-05-13T21:37:37.4257156+02:00</d2p1:CreatedDateTime>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsSasriaSelected>true</d2p1:IsSasriaSelected>
    <d2p1:IsTravelToRuralAreas>true</d2p1:IsTravelToRuralAreas>
    <d2p1:LastCoverDate>2025-05-13T21:37:37.4257156+02:00</d2p1:LastCoverDate>
    <d2p1:LicenseAge>11</d2p1:LicenseAge>
    <d2p1:Mileage>9</d2p1:Mileage>
    <d2p1:PreviousInsurerId>6</d2p1:PreviousInsurerId>
    <d2p1:TravelOnDirtRoadsId>8</d2p1:TravelOnDirtRoadsId>
    <d2p1:VehicleCondition>sample string 10</d2p1:VehicleCondition>
    <d2p1:VehicleId>4</d2p1:VehicleId>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfAdditionalVehicleFields_PYwLh37g>