POST residentapi/vehicles

Create a vehicle record for a unit

Request Information

URI Parameters

None.

Body Parameters

VehicleCreate
NameDescriptionTypeAdditional information
PropertyId

ConnectPropertyId

integer

Required

UnitId

ConnectUnitId

integer

Required

Make

Make

string

Required

Model

Model

string

Required

TagNumber

TagNumber

string

Required

Color

Color

string

Required

Year

Year

string

Required

RegistrationState

RegistrationState

string

Required

InsuranceCompany

InsuranceCompany

string

None.

InsurancePolicyNumber

InsurancePolicyNumber

string

None.

TypeId

TypeId - see GET residentapi/vehicletypes/{typeId}

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "propertyId": 1,
  "unitId": 2,
  "make": "sample string 3",
  "model": "sample string 4",
  "tagNumber": "sample string 5",
  "color": "sample string 6",
  "year": "sample string 7",
  "registrationState": "sample string 8",
  "insuranceCompany": "sample string 9",
  "insurancePolicyNumber": "sample string 10",
  "typeId": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Vehicle
NameDescriptionTypeAdditional information
VehicleId

VehicleId

integer

None.

PropertyId

ConnectPropertyId

integer

None.

UnitId

ConnectUnitId

integer

None.

Make

Make

string

None.

Model

Model

string

None.

Type

Type

string

None.

Year

Year

string

None.

Color

Color

string

None.

TagNumber

TagNumber

string

None.

InsuranceCompany

InsuranceCompany

string

None.

InsurancePolicyNumber

InsurancePolicyNumber

string

None.

RegistrationState

RegistrationState

string

None.

SpaceNumber

SpaceNumber

string

None.

DecalNumber

Decalnumber

string

None.

TypeId

TypeId - see GET residentapi/vehicletypes/{typeId}

integer

None.

Unit

UnitNumber

string

None.

Response Formats

application/json, text/json

Sample:
{
  "vehicleId": 1,
  "propertyId": 2,
  "unitId": 3,
  "make": "sample string 4",
  "model": "sample string 5",
  "type": "sample string 6",
  "year": "sample string 7",
  "color": "sample string 8",
  "tagNumber": "sample string 9",
  "insuranceCompany": "sample string 10",
  "insurancePolicyNumber": "sample string 11",
  "registrationState": "sample string 12",
  "spaceNumber": "sample string 13",
  "decalNumber": "sample string 14",
  "typeId": 1,
  "unit": "sample string 15"
}