PropertyUnitTypes
GET
/trestle/odata/PropertyUnitTypes
GET
/trestle/rets/search?SearchType=PropertyUnitTypes&Class=PropertyUnitTypes
UnitTypeKey is the primary key and uniquely identifies records in the PropertyUnitTypes resource.
The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time:
ListingId, ListingKey, ModificationTimestamp, UnitTypeKey.
Fields
| Field | Type | Size | Description |
|---|---|---|---|
| HumanModifiedYN | Boolean | HumanModifiedYN | |
| InternetEntireListingDisplayYN | Boolean | InternetEntireListingDisplayYN | |
| ListAgentKey | String | 20 | ListAgentKey |
| ListAOR | AOR Enum | ListAOR | |
| ListingId InKey | String | 255 | This is the foreign ID relating to the Property Resource. The well known identifier for the listing. The value may be identical to that of the Listing Key, but the Listing ID is intended to be the value used by a human to retrieve the information about a specific listing. In a multiple originating system or a merged system, this value may not be unique and may require the use of the provider system to create a synthetic unique value. |
| ListingKey InKey | String | 20 | The foreign key relating to the Property Resource; a unique identifier for this record from the immediate source; a string that can include a Uniform Resource Identifier (URI) or other forms. This is the local key of the system. When records are received from other systems, a local key is commonly applied. If conveying the original keys from the source or originating systems, see the Property Resource's SourceSystemKey and OriginatingSystemKey. |
| ListingKeyNumeric | Int64 | 10 | ListingKeyNumeric |
| ListingPermission | Permission Enum | ListingPermission | |
| ListOfficeKey | String | 20 | ListOfficeKey |
| ListOfficeMlsId | String | 40 | ListOfficeMlsId |
| ModificationTimestamp InKey | DateTimeOffset | Date/time this record was last modified. | |
| OffMarketDate | DateTime | OffMarketDate | |
| OriginatingSystemListingKey | String | 255 | OriginatingSystemListingKey |
| OriginatingSystemName | String | 255 | OriginatingSystemName |
| OriginatingSystemSubName | String | 255 | OriginatingSystemSubName |
| Permission | Permission Enum | Permission | |
| PermissionPrivate | String | 8000 | PermissionPrivate |
| PropertySubType | PropertySubType Enum | PropertySubType | |
| PropertySubTypeAdditional | PropertySubTypeAdditional Enum | PropertySubTypeAdditional | |
| PropertyType | PropertyType Enum | PropertyType | |
| SourceSystemID | String | 25 | SourceSystemID |
| StandardStatus | StandardStatus Enum | StandardStatus | |
| SyndicateTo | SyndicateTo Enum | SyndicateTo | |
| UnitTypeActualRent | Decimal | 14.2 | The actual rent per month being collected for a given type of unit. |
| UnitTypeActualRentRange | String | 50 | UnitTypeActualRentRange |
| UnitTypeArea | Decimal | 14.2 | UnitTypeArea |
| UnitTypeAreaSource | AreaSource Enum | UnitTypeAreaSource | |
| UnitTypeAreaUnits | AreaUnits Enum | UnitTypeAreaUnits | |
| UnitTypeBathsTotal | Int32 | 4 | The total number of baths for a given type of unit. |
| UnitTypeBedsTotal | Int32 | 4 | The total number of bedrooms for a given type of unit. |
| UnitTypeDeposit | Decimal | 14.2 | UnitTypeDeposit |
| UnitTypeDescription | String | 1024 | A textual description of a given type of unit. |
| UnitTypeFireplaceYN | Boolean | UnitTypeFireplaceYN | |
| UnitTypeFurnished | Furnished Enum | The level of furnishing for a given type of unit. i.e. furnished, partial or unfurnished. | |
| UnitTypeGarageAttachedYN | Boolean | Does the given type of unit have an attached garage? Yes/No. | |
| UnitTypeGarageSpaces | Decimal | 14.2 | The number of garage spaces included with the given type of unit. |
| UnitTypeKey Key InKey | String | 20 | A unique identifier for this record. This is a string that can include a Uniform Resource Identifier (URI) or other forms. This is the local key of the system. |
| UnitTypeKeyNumeric | Int32 | 4 | UnitTypeKeyNumeric |
| UnitTypeLeasedYN | Boolean | UnitTypeLeasedYN | |
| UnitTypeLeaseExpires | DateTime | UnitTypeLeaseExpires | |
| UnitTypeMonthToMonthYN | Boolean | UnitTypeMonthToMonthYN | |
| UnitTypeNumFullBaths | Int32 | 4 | UnitTypeNumFullBaths |
| UnitTypeNumHalfBaths | Int32 | 4 | UnitTypeNumHalfBaths |
| UnitTypeOccupantType | UnitTypeOccupantType Enum | UnitTypeOccupantType | |
| UnitTypePetDeposit | Decimal | 14.2 | UnitTypePetDeposit |
| UnitTypePetDepositPerPetYN | Boolean | UnitTypePetDepositPerPetYN | |
| UnitTypeProForma | Int32 | 4 | The pro forma rent, or the expected rental income from the given type of unit. This may vary from actual rent which can be affected by factors other than current market value. |
| UnitTypeTotalRent | Decimal | 14.2 | The total actual rent is the sum of all rent being collected for all units of the given type. For example if you had 5 units of a particular type each collecting $1000, the total actual rent would be $5000. |
| UnitTypeType | UnitTypeType Enum | A list of possible Unit Types. i.e. 1, 2, 3 or 2 Bed, Studio, Special Loft, etc. | |
| UnitTypeUnitNum | String | 25 | UnitTypeUnitNum |
| UnitTypeUnitsTotal | Int32 | 4 | The total number of units of the given type. |
Expands
| Name | Target |
|---|---|
| Property | Property |