GET api/DBA/GetYSFloorPlans/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
FloorPlansModel| Name | Description | Type | Additional information |
|---|---|---|---|
| unitTypeModel | Collection of UnitTypeModel |
None. |
|
| hotSheetUnitsModel | Collection of HotSheetUnitsModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"unitTypeModel": [
{
"unitTypeId": 1,
"dbaUnitTypeId": 1,
"dbaUnitTypeCode": "sample string 1",
"dbaUnitType": "sample string 2",
"bedRooms": "sample string 3",
"bathRooms": 4.1,
"area": 5.1,
"fileId": 1,
"fileName": "sample string 6",
"fileName2D": "sample string 7",
"unitTypeCode": "sample string 8",
"moveInSpecial": "sample string 9",
"availableUnitsCount": 10,
"fileName2DByte": "QEA=",
"fileNameByte": "QEA=",
"is3DShow": true,
"footnoteForWebsite": "sample string 11"
},
{
"unitTypeId": 1,
"dbaUnitTypeId": 1,
"dbaUnitTypeCode": "sample string 1",
"dbaUnitType": "sample string 2",
"bedRooms": "sample string 3",
"bathRooms": 4.1,
"area": 5.1,
"fileId": 1,
"fileName": "sample string 6",
"fileName2D": "sample string 7",
"unitTypeCode": "sample string 8",
"moveInSpecial": "sample string 9",
"availableUnitsCount": 10,
"fileName2DByte": "QEA=",
"fileNameByte": "QEA=",
"is3DShow": true,
"footnoteForWebsite": "sample string 11"
}
],
"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": "2025-07-06T12:24:54.9161798-05:00",
"AllowMaxMoveinDate": "2025-07-06T12:24:54.9161798-05:00",
"unitAvailableDate": "2025-07-06T12:24:54.9161798-05: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": "2025-07-06T12:24:54.9161798-05:00",
"AllowMaxMoveinDate": "2025-07-06T12:24:54.9161798-05:00",
"unitAvailableDate": "2025-07-06T12:24:54.9161798-05: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">
<hotSheetUnitsModel>
<HotSheetUnitsModel>
<AllowMaxMoveinDate>2025-07-06T12:24:54.9161798-05:00</AllowMaxMoveinDate>
<MoveInDateAvailable>2025-07-06T12:24:54.9161798-05: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>2025-07-06T12:24:54.9161798-05:00</unitAvailableDate>
<unitId>1</unitId>
<unitNumber>sample string 1</unitNumber>
</HotSheetUnitsModel>
<HotSheetUnitsModel>
<AllowMaxMoveinDate>2025-07-06T12:24:54.9161798-05:00</AllowMaxMoveinDate>
<MoveInDateAvailable>2025-07-06T12:24:54.9161798-05: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>2025-07-06T12:24:54.9161798-05:00</unitAvailableDate>
<unitId>1</unitId>
<unitNumber>sample string 1</unitNumber>
</HotSheetUnitsModel>
</hotSheetUnitsModel>
<unitTypeModel>
<UnitTypeModel>
<area>5.1</area>
<availableUnitsCount>10</availableUnitsCount>
<bathRooms>4.1</bathRooms>
<bedRooms>sample string 3</bedRooms>
<dbaUnitType>sample string 2</dbaUnitType>
<dbaUnitTypeCode>sample string 1</dbaUnitTypeCode>
<dbaUnitTypeId>1</dbaUnitTypeId>
<fileId>1</fileId>
<fileName>sample string 6</fileName>
<fileName2D>sample string 7</fileName2D>
<fileName2DByte>QEA=</fileName2DByte>
<fileNameByte>QEA=</fileNameByte>
<footnoteForWebsite>sample string 11</footnoteForWebsite>
<is3DShow>true</is3DShow>
<moveInSpecial>sample string 9</moveInSpecial>
<unitTypeCode>sample string 8</unitTypeCode>
<unitTypeId>1</unitTypeId>
</UnitTypeModel>
<UnitTypeModel>
<area>5.1</area>
<availableUnitsCount>10</availableUnitsCount>
<bathRooms>4.1</bathRooms>
<bedRooms>sample string 3</bedRooms>
<dbaUnitType>sample string 2</dbaUnitType>
<dbaUnitTypeCode>sample string 1</dbaUnitTypeCode>
<dbaUnitTypeId>1</dbaUnitTypeId>
<fileId>1</fileId>
<fileName>sample string 6</fileName>
<fileName2D>sample string 7</fileName2D>
<fileName2DByte>QEA=</fileName2DByte>
<fileNameByte>QEA=</fileNameByte>
<footnoteForWebsite>sample string 11</footnoteForWebsite>
<is3DShow>true</is3DShow>
<moveInSpecial>sample string 9</moveInSpecial>
<unitTypeCode>sample string 8</unitTypeCode>
<unitTypeId>1</unitTypeId>
</UnitTypeModel>
</unitTypeModel>
</FloorPlansModel>