GET api/Common/GetYieldStarUnits/{dateNeeded}/{leaseTermId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dateNeeded

date

Required
leaseTermId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of HotSheetModel
NameDescriptionTypeAdditional information
ApplicantId

integer

None.
GroupName

string

None.
HotListId

integer

None.
UnitId

integer

None.
UnitNumber

string

None.
DBAUnitTypeId

integer

None.
DBAUnitType

string

None.
DBAUnitTypeCode

string

None.
SquareFeet

decimal number

None.
OrginalDateAvailable

date

None.
UnitStatus

string

None.
DateAvailable

string

None.
MarketRent

decimal number

None.
Rent

decimal number

None.
StreetRent

decimal number

None.
EscrowDeposit

decimal number

None.
MoveInSpecial

string

None.
LookAndLease

boolean

None.
FeaturesOrComments

string

None.
FileName

string

None.
FileName2D

string

None.
MoveInDateAvailable

date

None.
AllowMaxMoveinDate

date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "applicantId": 1,
    "groupName": "sample string 2",
    "hotListId": 3,
    "unitId": 4,
    "unitNumber": "sample string 5",
    "dbaUnitTypeId": 6,
    "dbaUnitType": "sample string 7",
    "dbaUnitTypeCode": "sample string 8",
    "squareFeet": 9.0,
    "orginalDateAvailable": "2025-05-10T17:57:42.8338188-05:00",
    "unitStatus": "sample string 11",
    "dateAvailable": "sample string 12",
    "marketRent": 13.0,
    "rent": 14.0,
    "streetRent": 15.0,
    "escrowDeposit": 16.0,
    "moveInSpecial": "sample string 17",
    "lookAndLease": true,
    "featuresOrComments": "sample string 19",
    "fileName": "sample string 20",
    "fileName2D": "sample string 21",
    "moveInDateAvailable": "2025-05-10T17:57:42.8338188-05:00",
    "allowMaxMoveinDate": "2025-05-10T17:57:42.8338188-05:00"
  },
  {
    "applicantId": 1,
    "groupName": "sample string 2",
    "hotListId": 3,
    "unitId": 4,
    "unitNumber": "sample string 5",
    "dbaUnitTypeId": 6,
    "dbaUnitType": "sample string 7",
    "dbaUnitTypeCode": "sample string 8",
    "squareFeet": 9.0,
    "orginalDateAvailable": "2025-05-10T17:57:42.8338188-05:00",
    "unitStatus": "sample string 11",
    "dateAvailable": "sample string 12",
    "marketRent": 13.0,
    "rent": 14.0,
    "streetRent": 15.0,
    "escrowDeposit": 16.0,
    "moveInSpecial": "sample string 17",
    "lookAndLease": true,
    "featuresOrComments": "sample string 19",
    "fileName": "sample string 20",
    "fileName2D": "sample string 21",
    "moveInDateAvailable": "2025-05-10T17:57:42.8338188-05:00",
    "allowMaxMoveinDate": "2025-05-10T17:57:42.8338188-05:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfHotSheetModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HotSheetModel>
    <ApplicantId>1</ApplicantId>
    <GroupName>sample string 2</GroupName>
    <HotListId>3</HotListId>
    <UnitId>4</UnitId>
    <UnitNumber>sample string 5</UnitNumber>
    <DBAUnitTypeId>6</DBAUnitTypeId>
    <DBAUnitType>sample string 7</DBAUnitType>
    <DBAUnitTypeCode>sample string 8</DBAUnitTypeCode>
    <SquareFeet>9</SquareFeet>
    <OrginalDateAvailable>2025-05-10T17:57:42.8338188-05:00</OrginalDateAvailable>
    <UnitStatus>sample string 11</UnitStatus>
    <DateAvailable>sample string 12</DateAvailable>
    <MarketRent>13</MarketRent>
    <Rent>14</Rent>
    <StreetRent>15</StreetRent>
    <EscrowDeposit>16</EscrowDeposit>
    <MoveInSpecial>sample string 17</MoveInSpecial>
    <LookAndLease>true</LookAndLease>
    <FeaturesOrComments>sample string 19</FeaturesOrComments>
    <FileName>sample string 20</FileName>
    <FileName2D>sample string 21</FileName2D>
    <MoveInDateAvailable>2025-05-10T17:57:42.8338188-05:00</MoveInDateAvailable>
    <AllowMaxMoveinDate>2025-05-10T17:57:42.8338188-05:00</AllowMaxMoveinDate>
  </HotSheetModel>
  <HotSheetModel>
    <ApplicantId>1</ApplicantId>
    <GroupName>sample string 2</GroupName>
    <HotListId>3</HotListId>
    <UnitId>4</UnitId>
    <UnitNumber>sample string 5</UnitNumber>
    <DBAUnitTypeId>6</DBAUnitTypeId>
    <DBAUnitType>sample string 7</DBAUnitType>
    <DBAUnitTypeCode>sample string 8</DBAUnitTypeCode>
    <SquareFeet>9</SquareFeet>
    <OrginalDateAvailable>2025-05-10T17:57:42.8338188-05:00</OrginalDateAvailable>
    <UnitStatus>sample string 11</UnitStatus>
    <DateAvailable>sample string 12</DateAvailable>
    <MarketRent>13</MarketRent>
    <Rent>14</Rent>
    <StreetRent>15</StreetRent>
    <EscrowDeposit>16</EscrowDeposit>
    <MoveInSpecial>sample string 17</MoveInSpecial>
    <LookAndLease>true</LookAndLease>
    <FeaturesOrComments>sample string 19</FeaturesOrComments>
    <FileName>sample string 20</FileName>
    <FileName2D>sample string 21</FileName2D>
    <MoveInDateAvailable>2025-05-10T17:57:42.8338188-05:00</MoveInDateAvailable>
    <AllowMaxMoveinDate>2025-05-10T17:57:42.8338188-05:00</AllowMaxMoveinDate>
  </HotSheetModel>
</ArrayOfHotSheetModel>