GET api/units/{unitId}/profile

Unit Profile

Request Information

URI Parameters

Name	Description	Type	Additional information
unitId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Unit Profile

UnitProfileViewModel

Name	Type	Additional information
Id	integer	None.
UnitNumber	string	None.
Occupied	boolean	None.
PercentOwned	decimal number	None.
Description	string	None.
UnitTypeId	integer	None.
NumberOfShares	decimal number	None.
SquareFootage	decimal number	None.
NoOfRooms	integer	None.
Block	string	None.
Lot	string	None.
ParcelId	string	None.
LegalUnitNumber	string	None.
Address	AddressBaseViewModel	None.
Spaces	Collection of UnitSpaceViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "unitNumber": "sample string 2",
  "occupied": true,
  "percentOwned": 1.0,
  "description": "sample string 4",
  "unitTypeId": 1,
  "numberOfShares": 1.0,
  "squareFootage": 1.0,
  "noOfRooms": 1,
  "block": "sample string 5",
  "lot": "sample string 6",
  "parcelId": "sample string 7",
  "legalUnitNumber": "sample string 8",
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zipCode": "sample string 5",
    "country": "sample string 6"
  },
  "spaces": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "taxRate": 1.0,
      "percentageOfOwnership": 1.0,
      "spaceTypeName": "sample string 4"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "taxRate": 1.0,
      "percentageOfOwnership": 1.0,
      "spaceTypeName": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<UnitProfileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Units">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </Address>
  <Block>sample string 5</Block>
  <Description>sample string 4</Description>
  <Id>1</Id>
  <LegalUnitNumber>sample string 8</LegalUnitNumber>
  <Lot>sample string 6</Lot>
  <NoOfRooms>1</NoOfRooms>
  <NumberOfShares>1</NumberOfShares>
  <Occupied>true</Occupied>
  <ParcelId>sample string 7</ParcelId>
  <PercentOwned>1</PercentOwned>
  <Spaces>
    <UnitSpaceViewModel>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PercentageOfOwnership>1</PercentageOfOwnership>
      <SpaceTypeName>sample string 4</SpaceTypeName>
      <TaxRate>1</TaxRate>
    </UnitSpaceViewModel>
    <UnitSpaceViewModel>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PercentageOfOwnership>1</PercentageOfOwnership>
      <SpaceTypeName>sample string 4</SpaceTypeName>
      <TaxRate>1</TaxRate>
    </UnitSpaceViewModel>
  </Spaces>
  <SquareFootage>1</SquareFootage>
  <UnitNumber>sample string 2</UnitNumber>
  <UnitTypeId>1</UnitTypeId>
</UnitProfileViewModel>