POST api/Vendor/VehicleCheckOut

Used to checkout a vehicle

Request Information

URI Parameters

None.

Body Parameters

VehicleCheckOutParm
NameDescriptionTypeAdditional information
UserGUID

Unique system generated user identifier

string

None.

VehicleGUID

Unique system generated vehicle identifier

string

None.

OdometerOut

Odometer reading at check out

integer

None.

FuelLevelOut

Fuel level at check out

integer

None.

OilLevelOut

Oil level at check out

integer

None.

DamageNoteOut

Damage noted at check out

string

None.

MechanicalIssuesOut

Mechanical issues at check out

string

None.

SafetyCheckOut

Safty check at check out

boolean

None.

FuelCardOut

Fuel card at check out

boolean

None.

DollyOut

Dolly was checked out

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "UserGUID": "sample string 1",
  "VehicleGUID": "sample string 2",
  "OdometerOut": 3,
  "FuelLevelOut": 4,
  "OilLevelOut": 5,
  "DamageNoteOut": "sample string 6",
  "MechanicalIssuesOut": "sample string 7",
  "SafetyCheckOut": true,
  "FuelCardOut": true,
  "DollyOut": true
}

application/xml, text/xml

Sample:
<VehicleCheckOutParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <DamageNoteOut>sample string 6</DamageNoteOut>
  <DollyOut>true</DollyOut>
  <FuelCardOut>true</FuelCardOut>
  <FuelLevelOut>4</FuelLevelOut>
  <MechanicalIssuesOut>sample string 7</MechanicalIssuesOut>
  <OdometerOut>3</OdometerOut>
  <OilLevelOut>5</OilLevelOut>
  <SafetyCheckOut>true</SafetyCheckOut>
  <UserGUID>sample string 1</UserGUID>
  <VehicleGUID>sample string 2</VehicleGUID>
</VehicleCheckOutParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional 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>