POST Api/Vehicle/GetByID
Request Information
URI Parameters
None.
Body Parameters
VehicleParameterName | Description | Type | Additional information |
---|---|---|---|
ClientID | globally unique identifier |
None. |
|
PartnerID | globally unique identifier |
None. |
|
VehicleID | globally unique identifier |
None. |
|
IMEINo | string |
None. |
|
GroupID | globally unique identifier |
None. |
|
OrderID | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "ClientID": "c49bddb8-4b6c-4b0d-8e88-a54acf3e361c", "PartnerID": "ad963ce0-732a-4ce9-a712-b1a60dba5e59", "VehicleID": "b53ed22b-d14c-434a-adc5-fe4fd726321f", "IMEINo": "sample string 4", "GroupID": "e2879862-d816-499b-8e2d-8d5fd91ca986", "OrderID": "638247eb-3ae6-43e0-85c1-a8d4a078c3be" }
application/xml, text/xml
Sample:
<VehicleParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity"> <ClientID>c49bddb8-4b6c-4b0d-8e88-a54acf3e361c</ClientID> <GroupID>e2879862-d816-499b-8e2d-8d5fd91ca986</GroupID> <IMEINo>sample string 4</IMEINo> <OrderID>638247eb-3ae6-43e0-85c1-a8d4a078c3be</OrderID> <PartnerID>ad963ce0-732a-4ce9-a712-b1a60dba5e59</PartnerID> <VehicleID>b53ed22b-d14c-434a-adc5-fe4fd726321f</VehicleID> </VehicleParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VehicleViewModelName | Description | Type | Additional information |
---|---|---|---|
VehicleNo | string |
None. |
|
Color | string |
None. |
|
Odometer | integer |
None. |
|
Year | string |
None. |
|
VehicleGroup | VehicleGroupViewModel |
None. |
|
VehicleModel | VehicleModelViewModel |
None. |
|
VehicleType | VehicleType |
None. |
|
FuelType | FuelType |
None. |
|
FuelTankCapacity | integer |
None. |
|
Registration | document_detail_view_model |
None. |
|
Insurance | document_detail_view_model |
None. |
|
AdditionalInfo | AdditionInfo |
None. |
|
TempSensor1 | TempSensorViewModel |
None. |
|
TempSensor2 | TempSensorViewModel |
None. |
|
TempSensor3 | TempSensorViewModel |
None. |
|
TempSensor4 | TempSensorViewModel |
None. |
|
Humidity1 | TempSensorViewModel |
None. |
|
Humidity2 | TempSensorViewModel |
None. |
|
Humidity3 | TempSensorViewModel |
None. |
|
Humidity4 | TempSensorViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "VehicleNo": "sample string 1", "Color": "sample string 2", "Odometer": 3, "Year": "sample string 4", "VehicleGroup": { "Name": "sample string 1" }, "VehicleModel": { "Name": "sample string 1", "WeightCapacity": 2, "VolumeCapacity": 3 }, "VehicleType": 0, "FuelType": 0, "FuelTankCapacity": 1, "Registration": { "DocumentType": 1, "ReferenceNo": "sample string 2", "StartDate": "2025-05-20T22:11:07.3243833+04:00", "ExpiryDate": "2025-05-20T22:11:07.3243833+04:00", "Attachment": { "ImageString": "sample string 1" } }, "Insurance": { "DocumentType": 1, "ReferenceNo": "sample string 2", "StartDate": "2025-05-20T22:11:07.3243833+04:00", "ExpiryDate": "2025-05-20T22:11:07.3243833+04:00", "Attachment": { "ImageString": "sample string 1" } }, "AdditionalInfo": { "EngineNumber": "sample string 1", "ChassisNumber": "sample string 2" }, "TempSensor1": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "TempSensor2": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "TempSensor3": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "TempSensor4": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "Humidity1": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "Humidity2": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "Humidity3": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 }, "Humidity4": { "IsEnabled": true, "Name": "sample string 2", "Value": 3.1 } }
application/xml, text/xml
Sample:
<VehicleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Models"> <AdditionalInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity"> <d2p1:ChassisNumber>sample string 2</d2p1:ChassisNumber> <d2p1:EngineNumber>sample string 1</d2p1:EngineNumber> </AdditionalInfo> <Color>sample string 2</Color> <FuelTankCapacity>1</FuelTankCapacity> <FuelType>Petrol</FuelType> <Humidity1> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </Humidity1> <Humidity2> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </Humidity2> <Humidity3> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </Humidity3> <Humidity4> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </Humidity4> <Insurance> <Attachment xmlns:d3p1="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service"> <d3p1:ImageString>sample string 1</d3p1:ImageString> </Attachment> <DocumentType>1</DocumentType> <ExpiryDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-05-20T18:11:07.3243833Z</d3p1:DateTime> <d3p1:OffsetMinutes>240</d3p1:OffsetMinutes> </ExpiryDate> <ReferenceNo>sample string 2</ReferenceNo> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-05-20T18:11:07.3243833Z</d3p1:DateTime> <d3p1:OffsetMinutes>240</d3p1:OffsetMinutes> </StartDate> </Insurance> <Odometer>3</Odometer> <Registration> <Attachment xmlns:d3p1="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service"> <d3p1:ImageString>sample string 1</d3p1:ImageString> </Attachment> <DocumentType>1</DocumentType> <ExpiryDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-05-20T18:11:07.3243833Z</d3p1:DateTime> <d3p1:OffsetMinutes>240</d3p1:OffsetMinutes> </ExpiryDate> <ReferenceNo>sample string 2</ReferenceNo> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-05-20T18:11:07.3243833Z</d3p1:DateTime> <d3p1:OffsetMinutes>240</d3p1:OffsetMinutes> </StartDate> </Registration> <TempSensor1> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </TempSensor1> <TempSensor2> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </TempSensor2> <TempSensor3> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </TempSensor3> <TempSensor4> <IsEnabled>true</IsEnabled> <Name>sample string 2</Name> <Value>3.1</Value> </TempSensor4> <VehicleGroup> <Name>sample string 1</Name> </VehicleGroup> <VehicleModel> <Name>sample string 1</Name> <VolumeCapacity>3</VolumeCapacity> <WeightCapacity>2</WeightCapacity> </VehicleModel> <VehicleNo>sample string 1</VehicleNo> <VehicleType>None</VehicleType> <Year>sample string 4</Year> </VehicleViewModel>