POST api/Vendor/VehicleCheckIn
Used to checkin a vehicle
Request Information
URI Parameters
None.
Body Parameters
VehicleCheckInParm| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system assigned user identifier |
string |
None. |
| VehicleGUID |
Unique system assigned vehicle identifier |
string |
None. |
| OdometerIn |
The odometer ready at check in |
integer |
None. |
| FuelLevelIn |
The fuel level at check in |
integer |
None. |
| DamageNoteIn |
Damage noted at check in |
string |
None. |
| MechanicalIssuesIn |
Mechanical issues noted at check it |
string |
None. |
| FuelCardIn |
Fuel card returned |
boolean |
None. |
| DollyIn |
Dolly returned |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserGUID": "sample string 1",
"VehicleGUID": "sample string 2",
"OdometerIn": 3,
"FuelLevelIn": 4,
"DamageNoteIn": "sample string 5",
"MechanicalIssuesIn": "sample string 6",
"FuelCardIn": true,
"DollyIn": true
}
application/xml, text/xml
Sample:
<VehicleCheckInParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <DamageNoteIn>sample string 5</DamageNoteIn> <DollyIn>true</DollyIn> <FuelCardIn>true</FuelCardIn> <FuelLevelIn>4</FuelLevelIn> <MechanicalIssuesIn>sample string 6</MechanicalIssuesIn> <OdometerIn>3</OdometerIn> <UserGUID>sample string 1</UserGUID> <VehicleGUID>sample string 2</VehicleGUID> </VehicleCheckInParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
Required |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>