GET api/DBA/GetYSFloorPlans/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

FloorPlansModel
NameDescriptionTypeAdditional information
bedroomTypeModel

Collection of BedroomTypeModel

None.
unitTypeModel

Collection of UnitTypeModel

None.
hotSheetUnitsModel

Collection of HotSheetUnitsModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "bedroomTypeModel": [
    {
      "numBedRooms": 1,
      "bedRoomTypes": "sample string 1"
    },
    {
      "numBedRooms": 1,
      "bedRoomTypes": "sample string 1"
    }
  ],
  "unitTypeModel": [
    {
      "unitTypeId": 1,
      "dbaUnitTypeId": 1,
      "dbaUnitTypeCode": "sample string 1",
      "dbaUnitType": "sample string 2",
      "bedRooms": "sample string 3",
      "bathRooms": 4.1,
      "numBedRooms": 1,
      "bedRoomTypes": "sample string 5",
      "area": 6.1,
      "fileId": 1,
      "fileName": "sample string 7",
      "fileName2D": "sample string 8",
      "unitTypeCode": "sample string 9",
      "moveInSpecial": "sample string 10",
      "availableUnitsCount": 11,
      "fileName2DByte": "QEA=",
      "fileNameByte": "QEA=",
      "is3DShow": true,
      "footnoteForWebsite": "sample string 12",
      "orderBy": 13
    },
    {
      "unitTypeId": 1,
      "dbaUnitTypeId": 1,
      "dbaUnitTypeCode": "sample string 1",
      "dbaUnitType": "sample string 2",
      "bedRooms": "sample string 3",
      "bathRooms": 4.1,
      "numBedRooms": 1,
      "bedRoomTypes": "sample string 5",
      "area": 6.1,
      "fileId": 1,
      "fileName": "sample string 7",
      "fileName2D": "sample string 8",
      "unitTypeCode": "sample string 9",
      "moveInSpecial": "sample string 10",
      "availableUnitsCount": 11,
      "fileName2DByte": "QEA=",
      "fileNameByte": "QEA=",
      "is3DShow": true,
      "footnoteForWebsite": "sample string 12",
      "orderBy": 13
    }
  ],
  "hotSheetUnitsModel": [
    {
      "unitNumber": "sample string 1",
      "unitId": 1,
      "dbaUnitTypeId": 1,
      "dbaUnitType": "sample string 2",
      "floorLevel": "sample string 3",
      "bedRooms": "sample string 4",
      "bathRooms": "sample string 5",
      "dbaUnitTypeCode": "sample string 6",
      "squareFeet": 7.1,
      "dateAvailable": "sample string 8",
      "availableDate": "sample string 9",
      "rent": 10.1,
      "rentString": "sample string 11",
      "displayOrder": 1,
      "onlinePath": "sample string 12",
      "buildingId": 13,
      "buildingNumber": "sample string 14",
      "MoveInDateAvailable": "2026-02-03T21:11:17.0352111-06:00",
      "AllowMaxMoveinDate": "2026-02-03T21:11:17.0352111-06:00",
      "unitAvailableDate": "2026-02-03T21:11:17.0352111-06:00"
    },
    {
      "unitNumber": "sample string 1",
      "unitId": 1,
      "dbaUnitTypeId": 1,
      "dbaUnitType": "sample string 2",
      "floorLevel": "sample string 3",
      "bedRooms": "sample string 4",
      "bathRooms": "sample string 5",
      "dbaUnitTypeCode": "sample string 6",
      "squareFeet": 7.1,
      "dateAvailable": "sample string 8",
      "availableDate": "sample string 9",
      "rent": 10.1,
      "rentString": "sample string 11",
      "displayOrder": 1,
      "onlinePath": "sample string 12",
      "buildingId": 13,
      "buildingNumber": "sample string 14",
      "MoveInDateAvailable": "2026-02-03T21:11:17.0352111-06:00",
      "AllowMaxMoveinDate": "2026-02-03T21:11:17.0352111-06:00",
      "unitAvailableDate": "2026-02-03T21:11:17.0352111-06:00"
    }
  ]
}

application/xml, text/xml

Sample: 
<FloorPlansModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Models">
  <bedroomTypeModel>
    <BedroomTypeModel>
      <bedRoomTypes>sample string 1</bedRoomTypes>
      <numBedRooms>1</numBedRooms>
    </BedroomTypeModel>
    <BedroomTypeModel>
      <bedRoomTypes>sample string 1</bedRoomTypes>
      <numBedRooms>1</numBedRooms>
    </BedroomTypeModel>
  </bedroomTypeModel>
  <hotSheetUnitsModel>
    <HotSheetUnitsModel>
      <AllowMaxMoveinDate>2026-02-03T21:11:17.0352111-06:00</AllowMaxMoveinDate>
      <MoveInDateAvailable>2026-02-03T21:11:17.0352111-06:00</MoveInDateAvailable>
      <availableDate>sample string 9</availableDate>
      <bathRooms>sample string 5</bathRooms>
      <bedRooms>sample string 4</bedRooms>
      <buildingId>13</buildingId>
      <buildingNumber>sample string 14</buildingNumber>
      <dateAvailable>sample string 8</dateAvailable>
      <dbaUnitType>sample string 2</dbaUnitType>
      <dbaUnitTypeCode>sample string 6</dbaUnitTypeCode>
      <dbaUnitTypeId>1</dbaUnitTypeId>
      <displayOrder>1</displayOrder>
      <floorLevel>sample string 3</floorLevel>
      <onlinePath>sample string 12</onlinePath>
      <rent>10.1</rent>
      <rentString>sample string 11</rentString>
      <squareFeet>7.1</squareFeet>
      <unitAvailableDate>2026-02-03T21:11:17.0352111-06:00</unitAvailableDate>
      <unitId>1</unitId>
      <unitNumber>sample string 1</unitNumber>
    </HotSheetUnitsModel>
    <HotSheetUnitsModel>
      <AllowMaxMoveinDate>2026-02-03T21:11:17.0352111-06:00</AllowMaxMoveinDate>
      <MoveInDateAvailable>2026-02-03T21:11:17.0352111-06:00</MoveInDateAvailable>
      <availableDate>sample string 9</availableDate>
      <bathRooms>sample string 5</bathRooms>
      <bedRooms>sample string 4</bedRooms>
      <buildingId>13</buildingId>
      <buildingNumber>sample string 14</buildingNumber>
      <dateAvailable>sample string 8</dateAvailable>
      <dbaUnitType>sample string 2</dbaUnitType>
      <dbaUnitTypeCode>sample string 6</dbaUnitTypeCode>
      <dbaUnitTypeId>1</dbaUnitTypeId>
      <displayOrder>1</displayOrder>
      <floorLevel>sample string 3</floorLevel>
      <onlinePath>sample string 12</onlinePath>
      <rent>10.1</rent>
      <rentString>sample string 11</rentString>
      <squareFeet>7.1</squareFeet>
      <unitAvailableDate>2026-02-03T21:11:17.0352111-06:00</unitAvailableDate>
      <unitId>1</unitId>
      <unitNumber>sample string 1</unitNumber>
    </HotSheetUnitsModel>
  </hotSheetUnitsModel>
  <unitTypeModel>
    <UnitTypeModel>
      <area>6.1</area>
      <availableUnitsCount>11</availableUnitsCount>
      <bathRooms>4.1</bathRooms>
      <bedRoomTypes>sample string 5</bedRoomTypes>
      <bedRooms>sample string 3</bedRooms>
      <dbaUnitType>sample string 2</dbaUnitType>
      <dbaUnitTypeCode>sample string 1</dbaUnitTypeCode>
      <dbaUnitTypeId>1</dbaUnitTypeId>
      <fileId>1</fileId>
      <fileName>sample string 7</fileName>
      <fileName2D>sample string 8</fileName2D>
      <fileName2DByte>QEA=</fileName2DByte>
      <fileNameByte>QEA=</fileNameByte>
      <footnoteForWebsite>sample string 12</footnoteForWebsite>
      <is3DShow>true</is3DShow>
      <moveInSpecial>sample string 10</moveInSpecial>
      <numBedRooms>1</numBedRooms>
      <orderBy>13</orderBy>
      <unitTypeCode>sample string 9</unitTypeCode>
      <unitTypeId>1</unitTypeId>
    </UnitTypeModel>
    <UnitTypeModel>
      <area>6.1</area>
      <availableUnitsCount>11</availableUnitsCount>
      <bathRooms>4.1</bathRooms>
      <bedRoomTypes>sample string 5</bedRoomTypes>
      <bedRooms>sample string 3</bedRooms>
      <dbaUnitType>sample string 2</dbaUnitType>
      <dbaUnitTypeCode>sample string 1</dbaUnitTypeCode>
      <dbaUnitTypeId>1</dbaUnitTypeId>
      <fileId>1</fileId>
      <fileName>sample string 7</fileName>
      <fileName2D>sample string 8</fileName2D>
      <fileName2DByte>QEA=</fileName2DByte>
      <fileNameByte>QEA=</fileNameByte>
      <footnoteForWebsite>sample string 12</footnoteForWebsite>
      <is3DShow>true</is3DShow>
      <moveInSpecial>sample string 10</moveInSpecial>
      <numBedRooms>1</numBedRooms>
      <orderBy>13</orderBy>
      <unitTypeCode>sample string 9</unitTypeCode>
      <unitTypeId>1</unitTypeId>
    </UnitTypeModel>
  </unitTypeModel>
</FloorPlansModel>