Read Floor Plan

curl -G https://api.fortresstech.io/v1/properties/propertyId/floorPlans/floorPlanId \
     --data-urlencode fields=id,name,property.*,documents.type

{
  "amenities": [
    {
      "name": "name",
      "code": "code",
      "startDate": "2024-01-15T09:30:00Z",
      "endDate": "2024-01-15T09:30:00Z",
      "type": "UNIT",
      "feeAmount": 1.1,
      "includedInMarketRent": true,
      "propertyId": "propertyId",
      "unitId": "unitId",
      "floorPlanId": "floorPlanId",
      "organizationId": "organizationId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "avgLeasedRent": 1.1,
  "baseMarketRentAmount": 1200.5,
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "financialMarketRentAmount": 1200.5,
  "grossRentLimit": 1.1,
  "grossSqFt": 1200,
  "hudGrossRent": 1.1,
  "id": "id",
  "idempotencyId": "idempotencyId",
  "isAffordable": true,
  "isCommercial": true,
  "listings": [
    {
      "number": "number",
      "floorLevel": "floorLevel",
      "status": "VACANT_READY",
      "amenityFeeAmt": 1.1,
      "marketRentAmt": 1.1,
      "quotingRentAmt": 1.1,
      "floorPlanId": "floorPlanId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "buildingId": "buildingId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "marketingDesc": "marketingDesc",
  "marketingName": "marketingName",
  "maxRentPercent": 1.1,
  "name": "name",
  "nonOptionalChargeSum": 1.1,
  "numBaths": 1,
  "numBeds": 1,
  "numHalfBaths": 1,
  "organizationId": "organizationId",
  "property": {
    "name": "name",
    "shortName": "shortName",
    "email": "email",
    "phone": "phone",
    "physicalStreetAddress1": "physicalStreetAddress1",
    "physicalStreetAddress2": "physicalStreetAddress2",
    "physicalCity": "physicalCity",
    "physicalState": "physicalState",
    "physicalZip": "physicalZip",
    "physicalCountry": "physicalCountry",
    "mailingStreetAddress1": "mailingStreetAddress1",
    "mailingStreetAddress2": "mailingStreetAddress2",
    "mailingCity": "mailingCity",
    "mailingState": "mailingState",
    "mailingZip": "mailingZip",
    "mailingCountry": "mailingCountry",
    "phoneNumber": "phoneNumber",
    "faxNumber": "faxNumber",
    "timezone": "timezone",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "countyName",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "propertyId": "propertyId",
  "quotingRentAmount": 1200.5,
  "readableId": "readableId",
  "rentableSqFt": 1100,
  "units": [
    {
      "number": "number",
      "floorLevel": "floorLevel",
      "isADA": true,
      "status": "VACANT_READY",
      "floorPlanId": "floorPlanId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "buildingId": "buildingId",
      "currentHouseholdId": "currentHouseholdId",
      "lastMoveOutId": "lastMoveOutId",
      "priorLeaseId": "priorLeaseId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "vacantSince": "2024-01-15T09:30:00Z",
      "reportOrder": 1.1,
      "makeReadyDate": "makeReadyDate",
      "reportConfigurationValue": "Quoting Rent",
      "lastVacancyStartDate": "lastVacancyStartDate",
      "mostRecentApplicationId": "mostRecentApplicationId"
    }
  ],
  "updatedAt": "2024-01-15T09:30:00Z",
  "utilityAllowancesSum": 1.1
}

Info for a specific floor plan

Path parameters

propertyIdstringRequired

The id of the property

floorPlanIdstringRequired

The id of the floorPlan

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

amenitieslist of objects

avgLeasedRentdouble

baseMarketRentAmountdouble

createdAtdatetime

deletedAtdatetime

financialMarketRentAmountdouble

grossRentLimitdouble

grossSqFtinteger

hudGrossRentdouble

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

isAffordableboolean

isCommercialboolean

listingslist of objects

marketingDescstring

marketingNamestring

maxRentPercentdouble

namestring

nonOptionalChargeSumdouble

numBathsinteger

numBedsinteger

numHalfBathsinteger

organizationIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

quotingRentAmountdouble

readableIdstring

rentableSqFtinteger

unitslist of objects

updatedAtdatetime

utilityAllowancesSumdouble