Data Feeds - DataLinx XML format documentation

XSD

DataLinx XSD (XML schema definition) version 1.2

Annotated Sample XML

You can download a copy of this Sample DataLinx XML file:

<?xml version="1.0" encoding="utf-8" ?>

<RentLinx
  xmlns="http://www.rentlinx.com"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.rentlinx.com http://www.rentlinx.com/Products/DataLinx/DataLinx1_2.xsd"
  DataLinxVersion="1.2">
  <Properties>

    <!-- Property (Required): The main element type in the file. Include one Property element for each
    of your properties.  Each Property element represents one property or community at a single 
    address, but can contain any number of units.
         
    If a previously-submitted property is no longer available, then do not include a Property
    element for that Property; this will cause RentLinx to remove that property.
         
    LocalPropertyID attribute (Required): This value should be a value unique to each 
    property assigned by your system, for example, the property's ID in your database.  
    RentLinx uses this to understand whether the property is a previously-submitted 
    property (whose existing record in RentLinx should be updated), or is a new property.
         
    HasLeasingOffice attribute (Optional): A value of true indicates that this property should 
    display its own property-specific contact information, instead of showing the company's
    contact information.  Default value is false.
    -->
    <Property LocalPropertyID="1924" HasLeasingOffice="true">
      
      <!-- Description (Required): Maximum 2000 characters. -->
      <Description>Live like a king at Example Apartments!
      
At Example Apartments, you will enjoy spacious living with the conveniences of living in a great community with everything you will need nearby. You can choose from 1 or 2 bedroom air conditioned and convenient floor plans. 
      
You will be at home with no worries, we pay the heat, water, sewer, and trash bills! We are pleased to provide you with an Example Maintenance and Management staff that is second to none!</Description>

      <!-- LegalName (Optional): If you legally refer to this property by a name other than the 
      address - for example, the property is at "123 Forest St." but it's referred to as "Forest 
      Apartments" - put that name here. LegalName is only for legal community names. -->
      <LegalName>Example Apartments II</LegalName>
      
      <!-- These address fields are required. -->
      <Address>123 Example St.</Address>
      <City>Example Township</City>
      <State>MI</State>
      <Zip>49509</Zip>
      
      <!-- Zip4: Optional. -->
      <Zip4>4005</Zip4>

      <!-- HideActualAddress (Optional): Specify 1 to hide the address of this property.  Please note that many
      listing websites do not advertise rentals with a hidden address; therefore this option is not recommended.
      Default is 0. -->
      <HideActualAddress>0</HideActualAddress>

      <!-- NearestIntersection: Required only if HideActualAddress (above) has a value of 1; otherwise not used.
      Remember to construct valid XML by escaping ampersand characters as "&amp;" (as shown in this example). -->
      <NearestIntersection>1st Ave. &amp; Main St.</NearestIntersection>
      
      <!-- YearBuilt: Optional. -->
      <YearBuilt>1999</YearBuilt>

      <!-- NumberUnits (Optional): The total number of units you manage at this property. Default is 1. -->
      <NumberUnits>96</NumberUnits>
      
      <!-- Latitude, Longitude (Optional): These are used by RentLinx and our partner sites to show a "pin"
      with the location of your property on the map!  If these are not provided, RentLinx will attempt to
      look up the geo-coordinates of your property based on the address / city / state / zip values. -->
      <Latitude>42.8986630</Latitude>
      <Longitude>-85.6816320</Longitude>
      
      <!-- AcceptsHcv (Optional): Specify a value of 1 if this property accepts Section 8 / Housing Choice
      Vouchers (more info at www.hud.gov).  Default is 0. -->
      <AcceptsHcv>1</AcceptsHcv>
      
      <!-- WaitList (Optional): Some properties which regularly stay leased up choose to maintain a waitlist
      of potential residents.  Specify 0 for no waitlist, 1 for an open waitlist, and 2 for a closed waitlist. 
      Default is 0. -->
      <WaitList>1</WaitList>
      <WaitListDetails>Taking waitlist for 2019. Hurry, we are filling up fast!</WaitListDetails>

      <!-- PhoneNumber: Required if HasLeasingOffice="true" is set on the Property element above. 
      Do not include spaces or punctuation characters. -->
      <PhoneNumber>6165555720</PhoneNumber>

      <!-- PhoneExtension, FaxNumber: Optional.  Do not include spaces or punctuation. -->
      <PhoneExtension>216</PhoneExtension>
      <FaxNumber>6165555721</FaxNumber>
      
      <!-- EmailAddress: Required if HasLeasingOffice="true" is set on the Property element above. -->
      <EmailAddress>inquiries@apartments.example.com</EmailAddress>

      <!-- Website (Optional): Provide this property's unique URL if there is one; otherwise, 
      your company website URL can be used. Requires HasLeasingOffice="true" -->
      <Website>http://www.apartments.example.com/properties.jsp?id=1924</Website>

      <!-- OfficeHours: Optional. Requires HasLeasingOffice="true" -->
      <OfficeHours>Monday thru Friday 8:00-5:00</OfficeHours>

      <!-- NoFee (Optional): This is useful in markets such as New York City to designate that the 
      property is a "No Fee" listing, that is, the renter does not pay a fee to the agent. 
      A value of 1 indicates that this property does not have an agent fee; a value of 0  
      indicates that either the property does have an agent fee, or the property is 
      located in a region where agent fees are not used.  Default is 0. -->
      <NoFee>0</NoFee>
      
      <!-- Amenity: Amentities which apply to all units at this property, for example, utilities 
      included, pet policy, and accessibility/handicap information.  See below for a chart of ID 
      values.  Each Amenity element can optionally have a value, with a brief description or 
      details for that amenity. -->
      <Amenity AmenityID="1"></Amenity>
      <Amenity AmenityID="10">Breed restrictions apply</Amenity>
      <Amenity AmenityID="36"></Amenity>
      <Amenity AmenityID="75">Big Dogs require additional deposit</Amenity>

      <!-- PropertyType: The property type(s) which apply to this property, for example, "Apartments" 
      or "House".  See below for a chart of ID values. The primary property type should include the 
      Primary="true" attribute, and is required. Additional/secondary property types are optional. -->
      <PropertyType Primary="true">Apartments</PropertyType>
      <PropertyType>GardenStyle</PropertyType>
      <PropertyType>Senior</PropertyType>

      <!-- The photos for this property. Multiple PropertyPhoto elements may be included, one per photo.
      The default photo for the property can be set by including the Primary="true" attribute.

      Each PropertyPhoto element can optionally include a value, which is the photo's text caption.

      ImageUrl attribute: Required.

      ModificationDate attribute (Optional): If this is included, RentLinx will update the photo if
      the modification date value is newer than the previous modification date value for the photo. 
      -->
      <PropertyPhoto ImageUrl="http://www.apartments.example.com/images/community_photos/33_full.jpg"
        ModificationDate="2007-02-03T14:16:20.883" Primary="true">Example Exterior</PropertyPhoto>
      <PropertyPhoto ImageUrl="http://www.apartments.example.com/images/community_photos/34_full.jpg"
        ModificationDate="2007-01-15T14:16:20.883">Example Club House</PropertyPhoto>

      <!-- Unit: Each property must have at least one Unit element, and may have multiple Unit elements.
      
      To delete a unit, don't specify a Unit element for that unit.  (Alternatively, to mark a unit as
      leased without deleting that unit, use the IsOpenToLease element, below.)
      
      LocalPropertyID attribute (Required): This value should be a value unique to each 
      unit assigned by your system, for example, the unit's ID in your database.  
      RentLinx uses this to understand whether the unit is a previously-submitted 
      unit (whose existing record in RentLinx should be updated), or is a new unit.
      -->
      <Unit LocalUnitID="1234">

        <!-- UnitType (Required): Designates what this Unit element represents. Permitted values:
          - "singlefamilyhome": A single-family home.
          - "specific": A particular individual unit for rent, e.g "Apartment #101".
          - "type": A particular variety (type) of units for rent, e.g. "Two Bedroom".
        -->
        <UnitType>type</UnitType>
        
        <!-- Name (Optional): The individual unit's name (e.g. "Apartment #101"), or the unit type's 
        description ("Two Bedroom"). -->
        <Name>One Bedroom</Name>

        <!-- Description: Optional. -->
        <Description>Convenient open floor plan, large closets. 
        
Great value! We pay your heat, water, cooking, and trash! 
        
A must-see!!</Description>
        
        <!-- IsOpenToLease (Optional): A value of 1 indicates that new leases are being accepted on 
        this unit, even if it is currently occupied.  A value of 0 indicates that the unit is not 
        open to lease.  Specify 0 if the resident currently leasing the unit still has the option 
        to re-lease it.  Default is 0. -->
        <IsOpenToLease>1</IsOpenToLease>
        
        <!-- NumberUnits, MaxAdvertiseAvailable: Required if the UnitType (above) is "type".  
        NumberUnits is the total number of units of this type; MaxAdvertiseAvailable is the 
        number of this type of units that are currently available to lease. -->
        <NumberUnits>12</NumberUnits>
        <MaxAdvertiseAvailable>2</MaxAdvertiseAvailable>
        
        <!-- DateAvailable (Optional): The date this unit will become available, or if the unit is 
        not currently open to lease, then the end date of the current lease. yyyy-mm-dd format. -->
        <DateAvailable>2018-09-24</DateAvailable>
        
        <!-- RentIsBasedOnIncome (Optional): A value of 1 indicates that this unit participates in 
        a federal, local, or private subsidy program where rent is offered to residents based on 
        their income. Default is 0. -->
        <RentIsBasedOnIncome>0</RentIsBasedOnIncome>
        
        <!-- MinRent (Optional): The monthly rent for this unit, or if there are a range of rent values,
        the lower bound value of the range.  If this element is blank or omitted, the rent value for
        the unit will show as "Call". -->
        <MinRent>430</MinRent>
        
        <!-- MaxRent (Optional): If this unit has a range of rent values, the upper bound for the range.
        Omit this element or just leave it blank if this unit's rent is a single value, not a range. -->
        <MaxRent>480</MaxRent>
        
        <!-- MinDeposit (Optional): If this unit has a deposit, the deposit amount. If it has a range
        of deposit amounts, the lower bound value of the range. -->
        <MinDeposit>400</MinDeposit>

        <!-- MaxDeposit (Optional): If this unit has a range of deposit amounts, the upper bound value. -->
        <MaxDeposit></MaxDeposit>
        
        <!-- Bedrooms (Required): Specify -1 to indicate a room for rent, 0 to indicate a studio apartment,
        or 1 or more to indicate a standard apartment or house with number of standard bedrooms.  -->
        <Bedrooms>1</Bedrooms>

        <!-- FullBaths, HalfBaths (Optional): The respective counts of these room types. -->
        <FullBaths>1</FullBaths>
        <HalfBaths>0</HalfBaths>
        
        <!-- MinSquareFeet (Optional): The square footage of the unit, or if there are a range of square
        footage values among units of this type, the lower bound value of the range. -->
        <MinSquareFeet>700</MinSquareFeet>

        <!-- MaxSquareFeet (Optional): If there are a range of square footage values among units of this 
        type, the upper bound value of the range. -->
        <MaxSquareFeet>700</MaxSquareFeet>
        
        <!-- IsMobilityAccessbile (Optional): A value of 1 indicates that this unit is accessible to 
        people with mobility disibilities, including easy wheelchair access throughout. Default is 0. -->
        <IsMobilityAccessible>0</IsMobilityAccessible>
        
        <!-- IsVisionAccessible, IsHearingAccessible: A value of 1 indicates that this unit has amenities
        which make it accessible to people with vision and hearing disabilities, respectively. 
        Default is 0. -->
        <IsVisionAccessible>0</IsVisionAccessible>
        <IsHearingAccessible>0</IsHearingAccessible>

        <!-- UnitPhoto (Optional): Photos that are specific to this unit. (Note that photos that 
        are of the property as a whole should be included as PropertyPhoto elements, above).
        Multiple UnitPhoto elements may be included, one per photo.  The default photo for the 
        unit can be set by including the Primary="true" attribute.

        Each UnitPhoto element can optionally include a value, which is the photo's text caption.

        ImageUrl attribute: Required.

        ModificationDate attribute (Optional): If this is included, RentLinx will update the photo if
        the modification date value is newer than the previous modification date value for the photo. 
        -->
        <UnitPhoto ImageUrl="http://www.apartments.example.com/images/community_photos/20_full.jpg"
          ModificationDate="2007-02-03T14:16:20.883" Primary="true">One Bedroom Floor Plan</UnitPhoto>
        <UnitPhoto ImageUrl="http://www.apartments.example.com/images/community_photos/22_full.jpg"
          ModificationDate="2007-01-15T14:16:20.883">Completely remodeled kitchen</UnitPhoto>
      </Unit>
    </Property>
  </Properties>
  
  <!-- Extras (Optional): You can optionally include this element to specify one or more attachments
  and/or hyperlinks that will be displayed with a set of your properties.  -->
  <Extras>

    <!-- Attachment (Optional): A file attachment (such as a PDF) that will be displayed as part
    of the listing for one or more properties.  Any number of Attachment elements can be included.
    
    A value for each Attachment element is required, which is the displayed text for the attachment.
    
    AttachmentUrl (Required): The URL of the attachment file.
    
    ModificationDate attribute (Optional): If this is included, RentLinx will update the file if
    the modification date value is newer than the previous modification date value for the file. 
    
    PropertyIDs (Required): A comma-separated list of the LocalPropertyID values for which the 
    attachment should be shown.
    -->
    <Attachment AttachmentUrl="http://www.apartments.example.com/attachments/Application.pdf"
      ModificationDate="2007-01-15T14:16:20.883"
      PropertyIDs="1924,1925,1926,1927,1928">Rental Application</Attachment>

    <!-- Link (Optional): A clickable web link that will be displayed as part of the listing 
    for one or more properties.  Any number of Link elements can be included.
    
    A value for each Link element is required, which is the displayed text for the link.
    
    LinkUrl (Required): The target web page URL of the link.
    
    PropertyIDs (Required): A comma-separated list of the LocalPropertyID values for which the 
    link should be shown.
    -->
    <Link LinkUrl="http://www.apartments.example.com/virtual-tour" PropertyIDs="1924">Example Apartments Virtual Tour</Link>
    <Link LinkUrl="http://www.apartments.example.com/AllProperties" PropertyIDs="1924,1925,1926,1927,1928">This link applies to multiple properties</Link>
  </Extras>
</RentLinx>
                

Supported PropertyType and Amenity ID Values

Here's the list of all PropertyType element values.

Amenities

This is the list of all AmenityID values.