GET api/units/{unitId}/vehicles?page={page}&pageSize={pageSize}

Get all active vehicles for a unit

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
unitId	(Required)	integer	Required
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfVehicle

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of Vehicle	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "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"
    },
    {
      "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)