GET api/vehicles/{id}

Get vehicle by vehicle id

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
id	(Required)	integer	Required

Body Parameters

None.

Response Information

Resource Description

Vehicle

Name	Description	Type	Additional information
VehicleId	Vehicle Id. Primary key of the vehicles table	integer	None.
PropertyId	Property Id. See the GET api/properties/{propertyId} route to get the property data.	integer	None.
UnitId	Unit Id. See the GET api/units/{unitId} route to get the unit data.	integer	None.
TypeId	Vehicle Type Id. See the GET api/vehicles/vehicletypes route to get a list of vehicle types.	integer	None.
VehicleSpace	Vehicle Space.	string	None.
VehicleMake	Vehicle Make.	string	None.
VehicleModel	Vehicle Model.	string	None.
VehicleYear	Vehicle Year.	string	None.
VehicleColor	Vehicle Color.	string	None.
VehiclePlate	Vehicle Plate.	string	None.
VehicleInsuranceCompany	Vehicle Insurance Company.	string	None.
VehicleInsurancePolicy	Vehicle Insurance Policy.	string	None.
VehicleDecal	Vehicle Decal.	string	None.
RegistrationState	Registration State.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "VehicleId": 1,
  "PropertyId": 2,
  "UnitId": 1,
  "TypeId": 1,
  "VehicleSpace": "sample string 3",
  "VehicleMake": "sample string 4",
  "VehicleModel": "sample string 5",
  "VehicleYear": "sample string 6",
  "VehicleColor": "sample string 7",
  "VehiclePlate": "sample string 8",
  "VehicleInsuranceCompany": "sample string 9",
  "VehicleInsurancePolicy": "sample string 10",
  "VehicleDecal": "sample string 11",
  "RegistrationState": "sample string 12"
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)