POST apiassetoauth/driive/vehiclecheck
Send a completed vehicle check
Request Information
URI Parameters
None.
Body Parameters
The completed vehicle check
OAuthCompletedVehicleCheckModel| Name | Description | Type | Additional information |
|---|---|---|---|
| VehicleCheckStartedTime |
The time when the vehicle check was started |
date |
None. |
| VehicleCheckCompletionTime |
The time when the vehicle check was completed |
date |
None. |
| DriverName |
The driver name who completed the vehicle check |
string |
None. |
| DriverMobileNumber |
The mobile phone of the driver who completed the vehicle check |
string |
None. |
| Region |
The region of the driver who completed the vehicle check |
string |
None. |
| ServiceID |
The service id of the vehicle the check was done on |
integer |
None. |
| VehicleProvider |
The vehicle provider |
string |
None. |
| VehicleMake |
The vehicle make |
string |
None. |
| VehicleModel |
The vehicle model |
string |
None. |
| VehicleRegistration |
The vehicle reg |
string |
None. |
| Mileage |
The vehicle mileage |
integer |
None. |
| DriverSignatureS3Key |
AWS S3 link to the signature |
string |
None. |
| VehicleCheckSections |
The sections of the vehicle check |
Collection of OAuthCompletedVehicleCheckSectionModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"VehicleCheckStartedTime": "2025-12-13T19:16:09.6382245+00:00",
"VehicleCheckCompletionTime": "2025-12-13T19:16:09.6382245+00:00",
"DriverName": "sample string 3",
"DriverMobileNumber": "sample string 4",
"Region": "sample string 5",
"ServiceID": 6,
"VehicleProvider": "sample string 7",
"VehicleMake": "sample string 8",
"VehicleModel": "sample string 9",
"VehicleRegistration": "sample string 10",
"Mileage": 11,
"DriverSignatureS3Key": "sample string 12",
"VehicleCheckSections": [
{
"SectionID": 1,
"VehicleCheckItems": [
{
"ItemID": 1,
"Fault": true,
"NotApplicable": true,
"FaultDescription": "sample string 4",
"PhotoS3KeyCollection": [
"sample string 1",
"sample string 2"
],
"Notes": "sample string 5"
},
{
"ItemID": 1,
"Fault": true,
"NotApplicable": true,
"FaultDescription": "sample string 4",
"PhotoS3KeyCollection": [
"sample string 1",
"sample string 2"
],
"Notes": "sample string 5"
}
]
},
{
"SectionID": 1,
"VehicleCheckItems": [
{
"ItemID": 1,
"Fault": true,
"NotApplicable": true,
"FaultDescription": "sample string 4",
"PhotoS3KeyCollection": [
"sample string 1",
"sample string 2"
],
"Notes": "sample string 5"
},
{
"ItemID": 1,
"Fault": true,
"NotApplicable": true,
"FaultDescription": "sample string 4",
"PhotoS3KeyCollection": [
"sample string 1",
"sample string 2"
],
"Notes": "sample string 5"
}
]
}
]
}
application/xml, text/xml
Sample:
<OAuthCompletedVehicleCheckModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<VehicleCheckStartedTime>2025-12-13T19:16:09.6382245+00:00</VehicleCheckStartedTime>
<VehicleCheckCompletionTime>2025-12-13T19:16:09.6382245+00:00</VehicleCheckCompletionTime>
<DriverName>sample string 3</DriverName>
<DriverMobileNumber>sample string 4</DriverMobileNumber>
<Region>sample string 5</Region>
<ServiceID>6</ServiceID>
<VehicleProvider>sample string 7</VehicleProvider>
<VehicleMake>sample string 8</VehicleMake>
<VehicleModel>sample string 9</VehicleModel>
<VehicleRegistration>sample string 10</VehicleRegistration>
<Mileage>11</Mileage>
<DriverSignatureS3Key>sample string 12</DriverSignatureS3Key>
<VehicleCheckSections>
<OAuthCompletedVehicleCheckSectionModel>
<SectionID>1</SectionID>
<VehicleCheckItems>
<OAuthCompletedVehicleCheckItemModel>
<ItemID>1</ItemID>
<Fault>true</Fault>
<NotApplicable>true</NotApplicable>
<FaultDescription>sample string 4</FaultDescription>
<PhotoS3KeyCollection>
<string>sample string 1</string>
<string>sample string 2</string>
</PhotoS3KeyCollection>
<Notes>sample string 5</Notes>
</OAuthCompletedVehicleCheckItemModel>
<OAuthCompletedVehicleCheckItemModel>
<ItemID>1</ItemID>
<Fault>true</Fault>
<NotApplicable>true</NotApplicable>
<FaultDescription>sample string 4</FaultDescription>
<PhotoS3KeyCollection>
<string>sample string 1</string>
<string>sample string 2</string>
</PhotoS3KeyCollection>
<Notes>sample string 5</Notes>
</OAuthCompletedVehicleCheckItemModel>
</VehicleCheckItems>
</OAuthCompletedVehicleCheckSectionModel>
<OAuthCompletedVehicleCheckSectionModel>
<SectionID>1</SectionID>
<VehicleCheckItems>
<OAuthCompletedVehicleCheckItemModel>
<ItemID>1</ItemID>
<Fault>true</Fault>
<NotApplicable>true</NotApplicable>
<FaultDescription>sample string 4</FaultDescription>
<PhotoS3KeyCollection>
<string>sample string 1</string>
<string>sample string 2</string>
</PhotoS3KeyCollection>
<Notes>sample string 5</Notes>
</OAuthCompletedVehicleCheckItemModel>
<OAuthCompletedVehicleCheckItemModel>
<ItemID>1</ItemID>
<Fault>true</Fault>
<NotApplicable>true</NotApplicable>
<FaultDescription>sample string 4</FaultDescription>
<PhotoS3KeyCollection>
<string>sample string 1</string>
<string>sample string 2</string>
</PhotoS3KeyCollection>
<Notes>sample string 5</Notes>
</OAuthCompletedVehicleCheckItemModel>
</VehicleCheckItems>
</OAuthCompletedVehicleCheckSectionModel>
</VehicleCheckSections>
</OAuthCompletedVehicleCheckModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Bool indicating if the check was saved successfully
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean>true</boolean>