Collapse Drawer
    Expand Drawer

    PropertyRooms

    GET

    /trestle/odata/PropertyRooms

    GET

    /trestle/rets/search?SearchType=PropertyRooms&Class=PropertyRooms

    info icon

    RoomKey is the primary key and uniquely identifies records in the PropertyRooms resource.

    info icon

    The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time: ListingId, ListingKey, ModificationTimestamp, RoomKey.

    Fields

    Field Type Size Description
    HumanModifiedYN Boolean
    ListAgentKey String 255
    ListOfficeKey String
    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 255 This is the foreign key relating to the Property Resource. A unique identifier for this record from the immediate source. This is a string that can include URI or other forms. Alternatively use the ListingKeyNumeric for a numeric only key field. 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 SourceSystemKey and OriginatingSystemKey.
    ListingKeyNumeric Int32 255 This is the foreign key relating to the property resource. A unique identifier for this record from the immediate source. This is the numeric only key and used as an alternative to the ListingKey fields. 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 SourceSystemKey and OriginatingSystemKey.
    ModificationTimestamp InKey DateTimeOffset 27 Date/time this record was last modified.
    OriginatingSystemName String 255
    OriginatingSystemSubName String 255
    Permission Permission Enum
    PermissionPrivate String 255
    RoomArea Decimal 14.2 The area of the room being described. Use the RoomAreaUnits field to describe the unit of measurement for the value in this field.
    RoomAreaSource AreaSource Enum The source of the measurement of the given room's area.
    RoomAreaUnits AreaUnits Enum The unit of measurement used for the value in the RoomArea field. e.g. square feet, square meters, etc.
    RoomDescription String 1024 A textual description of the given room.
    RoomDimensions String 50 A textual description of the dimensions of the given room.
    RoomFeatures InteriorOrRoomFeatures Enum A list of features present in the given room.
    RoomFlooring Flooring Enum
    RoomKey Key InKey String 255 A unique identifier for this record. This is a string that can include URI or other forms. Alternatively use the "...KeyNumeric" for a numeric only key field. This is the local key of the system.
    RoomKeyNumeric Int32 255 A unique identifier for this record. This is the numeric only key and used as an alternative to the string Key field. This is the local key of the system.
    RoomLength Decimal 14.2 A numeric representation of the length of the given room. See the RoomLengthWidthUnits for the unit of measurement used for the length and width.
    RoomLengthWidthSource AreaSource Enum The source of the measurement of the given units length and width.
    RoomLengthWidthUnits LinearUnits Enum The unit of measurement used for the value in the RoomLength and the RoomWidth fields. e.g. feet, meters, etc.
    RoomLevel RoomLevel Enum The level within the dwelling on which the given room is located.
    RoomType RoomType Enum The type of room being described by the other fields in the PropertyRooms resource.
    RoomWidth Decimal 14.2 A numeric representation of the width of the given room. See the RoomLengthWidthUnits for the unit of measurement used for the length and width.

    Expands

    Name Target Description
    Property Property