GET api/unitTypes/search?unitTypeId={unitTypeId}&buildingId={buildingId}

Search Unit Types by Id, Building Id, or return all if blank

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitTypeId

Optional - Search by a unit type Id

integer

None.

buildingId

Optional - Search by a building Id

integer

None.

Body Parameters

None.

Response Information

Resource Description

UnitTypeViewModel
NameDescriptionTypeAdditional information
Id

Unit Type Id

integer

None.

BuildingId

Building Id

integer

Required

Range: inclusive between 1 and 2147483647

Description

Unit Type Number (Short Description)

string

Required

Matching regular expression pattern: ^[^,'"]*$

Max length: 50

DetailDescription

Unit Type Detail Description

string

Max length: 50

PercentageOfOwnership

Nullable Percentage of Ownership

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "buildingId": 2,
  "description": "sample string 3",
  "detailDescription": "sample string 4",
  "percentageOfOwnership": 1.0
}

application/xml, text/xml

Sample:
<UnitTypeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.UnitType">
  <BuildingId>2</BuildingId>
  <Description>sample string 3</Description>
  <DetailDescription>sample string 4</DetailDescription>
  <PercentageOfOwnership>1</PercentageOfOwnership>
  <Id>1</Id>
</UnitTypeViewModel>