Table of Contents

Report.xml Specification

The core of an RPTI file is Report.xml, a concise representation of any appraisal report Appraise-It Pro supports. Report.xml is based on SFREP's internal AIXML format.

AIXML Schema

An AIXML schema in XSD format is available for download here.

AIXML Structure Overview

Below is a condensed look at AIXML's structure. (A condensed sample AIXML populated with sample values is available on the Sample RPTI File page.)

The Report root element supports four child elements: Application, Geocoding, Forms, and DynamicFields. Geocoding contains child Address elements; Forms contains child Form or DynamicForm elements; and DynamicFields contains child ReportFields, CompFields, RentalFields, and Images elements.

DynamicForm and DynamicFields elements are only used for dynamic reports, such as the UAD 3.6 URAR.

<?xml version="1.0" encoding="utf-16"?>
<Report xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Application VendorName="" ProductName="" ProductVersion="" AixmlVersion="1.5" />
  <Geocoding>
    <Address Street="" Source="" Latitude="" Longitude="" Precision="" />
  </Geocoding>
  <Forms>
    <Form Id="">
      <Fields>
        <TextField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
          <UnitIndex></UnitIndex>
          <ExtendedComment Title="" Data="" />
        </TextField>
        <CheckBoxField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
          <UnitIndex></UnitIndex>
          <ExtendedComment Title="" Data="" />
        </CheckBoxField>
        <ImageField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
          <UnitIndex></UnitIndex>
        </ImageField>
        <WordProcessingField Id="" Data="" />
        <PdfField Id="" Data="" />
      </Fields>      
    </Form>    
  </Forms>
  <DynamicFields>
    <ReportFields>
      <RowGroups>
        <RowGroup Id="">
          <Fields>
            <DynamicCheckBoxField Id="" Data="" />
            <DynamicTextField Id="" Data="" />
            <DynamicImageField Id="" Data="" />
            <DynamicImageListField Id="">
              <Data>
                <ImageReference Label="" PrintLayout="" />
              </Data>
            </DynamicImageListField>
            <NestedRowGroup>
              <Fields>
                <DynamicCheckBoxField Id="" Data="" />
                <DynamicTextField Id="" Data="" />
                <DynamicImageField Id="" Data="" />
                <DynamicImageListField Id="">
                  <Data>
                    <ImageReference Label="" PrintLayout="" />
                  </Data>
                </DynamicImageListField>
              </Fields>
            </NestedRowGroup>
          </Fields>
        </RowGroup>
      </RowGroups>
      <Structures>
        <Structure Name="" IsManufacturedHome="">
          <RowGroups>
            <RowGroup Id="">
              <Fields />
            </RowGroup>
          </RowGroups>
          <LivingUnits>
            <Unit Name="">
              <RowGroups />
            </Unit>
          </LivingUnits>
          <Adus>
            <Adu Name="">
              <RowGroups />
            </Adu>
          </Adus>
        </Structure>
      </Structures>
      <Outbuildings>
        <Outbuilding OutbuildingType=""
                     OutbuildingTypeOtherDescription="">
          <RowGroups>
            <RowGroup Id="">
              <Fields />
            </RowGroup>
          </RowGroups>
          <Adus>
            <Adu Name="">
              <RowGroups />
            </Adu>
          </Adus>
        </Outbuilding>
      </Outbuildings>
    </ReportFields>
    <CompFields>
      <CompGrid CompType="">
        <Comp>
          <RowGroups />
          <Structures />
          <Outbuildings />
        </Comp>
      </CompGrid>
    </CompFields>
    <RentalFields>
      <Rental>
        <RowGroups>
            <RowGroup Id="">
              <Fields />
            </RowGroup>
        </RowGroups>
        <ComparisonFields>
          <SubjectUnit SubjectStructureIndex=""
                       SubjectStructureLivingUnitIndex=""
                       SubjectStructureAduIndex=""
                       SubjectOutbuildingIndex=""
                       SubjectOutbuildingAduIndex=""
                       UsedForComparison="">
            <RowGroups>
              <RowGroup Id="">
                <Fields />
              </RowGroup>
            </RowGroups>
          </SubjectUnit>
        </ComparisonFields>
      </Rental>
    </RentalFields>
    <Images>
      <Image Id="" FileName="" Caption="" CreationDateTime="">
        <Elevation Value="" Units="" />
        <Location Latitude="" Longitude="" />
      </Image>
    </Images>
  </DynamicFields>
</Report>

AIXML Structure Detail

Prolog and Root Element

Include a prolog defining the XML version and character encoding, then the document's root element.

<?xml version="1.0" encoding="utf-16"?>
<Report xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  
  ...
  
</Report>

Application Element

The first child element is Application. This contains information about the software used to generate the file and the version of AIXML in use.

<Application VendorName="" ProductName="" ProductVersion="" AixmlVersion="1.5" />
Attribute Conditionality Description
VendorName Required Name of the software vendor.
ProductName Required Name of the software product.
ProductVersion Required Version number of the software product.
AixmlVersion Required Version number of the encapsulating AIXML. Must be "1.5".

Geocoding and Address Elements

The second child element is Geocoding. This is a cache of street addresses and geocoded coordinates. Each street address is represented by an Address child element. There is no limit on how many Address elements may be included, but Address elements must be unique: if the same property appears in different contexts within the report, it should only have one Address element within the Geocoding element.

Note that the Geocoding element as a whole is optional and may be omitted.

<Geocoding>
  <Address Street="" Source="" Latitude="" Longitude="" Precision="" />
</Geocoding>
Attribute Conditionality Description
Street Required Street address that corresponds to either the subject or a comparable within the report.
Source Optional The name of the geocoding service or provider.
Latitude Required Latitude of the address.
Longitude Required Longitude of the address.
Precision Optional Assurance score as returned by the geocoding service or provider.

Forms and Form/DynamicForm Elements

The third child element is Forms. This is a list of all forms within the report, each represented by a Form or DynamicForm child element.

There is no limit on how many Form or DynamicForm elements may be included; however, there must be exactly one "primary" form present.

Appraise-It Pro's report files are built around the expectation of a single primary form (i.e. a Fannie Mae 1004) with addenda. A list of supported primary forms is available in the New tab in the Backstage view. When a report is open, the primary form is denoted by a yellow star icon next to it in the Report pane.

The correct value for a given form's Form Id attribute can be looked up in Appraise-It Pro's Field Details pane.

Each Form element contains several child elements representing the contents of that form, described in the following sections.

<Forms>
  <Form Id="">
    
    ...
    
  </Form>
</Forms>

DynamicForm elements are always empty. Their contents are populated in the DynamicFields element.

<Forms>
  <DynamicForm Id="" />
</Forms>
Attribute Conditionality Description
Id Required Unique identifier for the form.

Some addenda in Appraise-It Pro's library are "repeatable", i.e. multiple instances of the same addendum can exist side by side within the same report file. Repeatable addenda support an optional CustomTitle attribute, which allows you to specify a nickname for that instance of that addendum to differentiate it in Appraise-It Pro's Report pane.

<Form Id="FaxScan" CustomTitle="Appraiser License" />

CustomTitle attributes specified for forms that don't support them will be ignored.

Fields Element and Children

The only child element of Form is Fields, which for almost all static forms contains any number of three types of child elements: Field, CheckBox, and Image. Each child element corresponds to data fields found on the parent form.

<Fields> 
  <TextField />
  <CheckBoxField />
  <ImageField />
</Fields>

TextField Element

The TextField element represents text fields. The values for its attributes, except Data, can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if a text field's TextField element is omitted completely, its Data attribute is omitted from its TextField element, or its Data attribute is set to "xsi:nil", that text field will be ignored by the import process. If its Data attribute is set to empty text or white space and Overwrite populated fields is selected in the import dialog, that text field will be cleared.

<TextField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="" />
Attribute Conditionality Description
Id Required Unique identifier for the field.
BaseCompIndex Conditionally Required For comparable fields, this is the index of the comparable on the form. For non-comparable fields, must be "0" or omitted.
CompType Conditionally Required For comparable fields, this is the type of the comparable on the form (i.e. "SalesComparable"). For non-comparable fields, must be "None" or omitted.
SignatureType Conditionally Required For fields associated with a signature. For non-signature fields, must be "None" or omitted.Note
Data Required The value for this field. Must be text.

The Field element has two optional child elements, which can be omitted if not needed, as in the above structure.

<TextField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
  <UnitIndex></UnitIndex>
</TextField>

UnitIndex's value is the integer index of the unit number to which this field applies.

<TextField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
  <ExtendedComment Title="" Data="" />
</TextField>

If the form field has an extended comment in Appraise-It Pro, ExtendedComment may be populated. (Extended comments are generally only found on the primary form in a report. If a form field supports extended comments, it is rendered in a different color than form fields that do not.)

ExtendedComment Attributes

Attribute Conditionality Description
Title Optional Title of the extended comment. If none is specified, the default title present in Appraise-It Pro's form file will be used.
Data Optional The case-sensitive name of the file, in the Rtf folder within the RPTI container file, which contains the RTF data.

CheckBoxField Element

The CheckBoxField element represents check box fields. The values for its attributes, except Data, can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if a check box field's CheckBoxField element is omitted completely, its Data attribute is omitted from its CheckBoxField element, or its Data attribute is set to "xsi:nil", that check box field will be ignored by the import process. If its Data attribute is set to false and Overwrite populated fields is selected in the import dialog, that check box field will be erased.

<CheckBoxField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="" />
Attribute Conditionality Description
Id Required Unique identifier for the field.
BaseCompIndex Conditionally Required For comparable fields, this is the index of the comparable on the form. For non-comparable fields, must be "0" or omitted.
CompType Conditionally Required For comparable fields, this is the type of the comparable on the form (i.e. "SalesComparable"). For non-comparable fields, must be "None" or omitted.
SignatureType Conditionally Required For fields associated with a signature. For non-signature fields, must be "None" or omitted.Note
Data Required The boolean value for this field. Must be "true" (checked) or "false" (unchecked).

The CheckBoxField element has two optional child elements, which can be omitted if not needed, as in the above structure.

<CheckBoxField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
  <UnitIndex></UnitIndex>
</CheckBoxField>

UnitIndex's value is the integer index of the unit number to which this field applies.

<CheckBoxField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
  <ExtendedComment Title="" Data="" />
</CheckBoxField>

If the check box field has an extended comment in Appraise-It Pro, ExtendedComment may be populated. (Extended comments are generally only found on the primary form in a report. If a form field supports extended comments, it is rendered in a different color than form fields that do not.)

ExtendedComment Attributes

Attribute Conditionality Description
Title Optional Title of the extended comment. If none is specified, the default title present in Appraise-It Pro's form file will be used.
Data Optional The case-sensitive name of the file, in the Rtf folder within the RPTI container file, which contains the RTF data.

ImageField Element

The ImageField element represents image fields. The values for its attributes, except Data, can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if an image field's ImageField element is omitted completely, its Data attribute is omitted from its ImageField element, or its Data attribute is set to "xsi:nil", that image field will be ignored by the import process. If its Data attribute is set to empty text or white space and Overwrite populated fields is selected in the import dialog, that image field will be cleared.

<ImageField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="" />
Attribute Conditionality Description
Id Required Unique identifier for the field.
BaseCompIndex Conditionally Required For comparable fields, this is the index of the comparable on the form. For non-comparable fields, must be "0" or omitted.
CompType Conditionally Required For comparable fields, this is the type of the comparable on the form (i.e. "SalesComparable"). For non-comparable fields, must be "None" or omitted.
SignatureType Conditionally Required For fields associated with a signature. For non-signature fields, must be "None" or omitted.Note
Data Required The name of the image file, in the Images folder within the RPTI container file.

The ImageField element has an optional child element, which can be omitted if not needed, as in the above structure.

<ImageField Id="" BaseCompIndex="" CompType="" SignatureType="" Data="">
  <UnitIndex></UnitIndex>
</ImageField>

UnitIndex's value is the integer index of the unit number to which this field applies.

Special Cases: Word Processing Addenda, PDF Addenda, and Signature Fields

Appraise-It Pro supports two types of repeatable full-page static addenda that exist to easily include rich-text data and PDFs, and does not support setting certain signature-related field values in RPTI files.

Word Processing Addenda

Appraise-It Pro supports two styles of word processing addenda: one with a form header that matches the other addenda in the forms library, and one with no header. The Form Id for the former is "WordProcessingAddendum" and the Id for the latter is "WordProcessingAddendum-NoHeaders".

The only field on the addendum is a placeholder location to display an RTF file.

<Forms>
  <Form Id="">
    <Fields>
      <WordProcessingField Id="WordProcessingPages" Data="" />
    </Fields>
  </Form>
</Forms>

Form Attributes

Attribute Conditionality Description
Id Required Unique identifier for the form. Must be "WordProcessingAddendum" or "WordProcessingAddendum-NoHeaders".

Field Attributes

Attribute Conditionality Description
Id Required Unique identifier for the field. Must be "WordProcessingPages".
Data Required The case-sensitive name of the file, in the Rtf folder within the RPTI container file, which contains the RTF data.

PDF Addenda

Appraise-It Pro supports PDF addenda with no headers. The Form Id is "PDFAddendum".

The only field on the addendum is a placeholder location to display a PDF file.

<Forms>
  <Form Id="PDFAddendum">
    <Fields>
      <PdfField Id="Pdf" Data="" />
    </Fields>
  </Form>
</Forms>

Form Attributes

Attribute Conditionality Description
Id Required Unique identifier for the form. Must be "PDFAddendum".

Field Attributes

Attribute Conditionality Description
Id Required Unique identifier for the field. Must be "Pdf".
Data Required The name of the PDF file, in the Pdf folder within the RPTI container file.

Signature Fields

The following field IDs are controlled by Appraise-It Pro's licensing system and will be ignored if populated in an RPTI file.

  • Signature
  • SignatureName
  • SignatureCompanyName
  • SignatureCompanyStreetAddress
  • SignatureCompanySecondLineAddress
  • SignatureCompanyCity
  • SignatureCompanyState
  • SignatureCompanyZipCode
  • SignatureCompanyUnparsedAddress
  • SignatureCompanyPhoneNumber
  • SignatureEmailAddress
  • SignatureCombinedIdentifyingNumberAndState
  • SignatureCertificationNumber
  • SignatureCertifyingState
  • SignatureLicenseNumber
  • SignatureLicensingState
  • SignatureOtherIdentifyingNumber
  • SignatureIdentifyingNumber
  • SignatureIdentifyingNumberIsLicenseCheckBox
  • SignatureIdentifyingNumberIsCertificationCheckBox
  • SignatureExpirationDate

DynamicFields and Children

The fourth child element is DynamicFields. This is a "data store" shared by any and all dynamic forms within the report.

DynamicFields supports four child elements: ReportFields, CompFields, RentalFields, and Images.

<DynamicFields>
  <ReportFields>
  
    ...
    
  </ReportFields>
  <CompFields>
  
    ...
    
  </CompFields>
  <RentalFields>
  
    ...
    
  </RentalFields>
  <Images>
  
    ...
    
  </Images>
</DynamicFields>

ReportFields Element and Children

The first child element of DynamicFields is ReportFields, which contains RowGroups, Structures, and Outbuildings elements.

Structures and Outbuildings elements contain any number of Structure and Outbuilding child elements, respectively, each of which contain a RowGroups child element.

RowGroups Element

RowGroups elements, whether under ReportFields, Structure, or Outbuilding elements, can contain any number of RowGroup elements.

Typically, the first RowGroup element within a parent RowGroups element will omit the Id attribute and be used to represent data on the overall dynamic form, or within the specified structure or outbuilding, that is not contained within a named row group.

RowGroup elements contain one child element, Fields, which in turn may contain any number of five possible child elements: DynamicTextField, DynamicCheckBoxField, DynamicImageField, DynamicImageListField, and NestedRowGroup.

<ReportFields>
  <RowGroups>
    <RowGroup Id="">
    
    ...
    
    </RowGroup>
  </RowGroups>
  <Structures>
    <Structure Name="">
      <RowGroups>
        <RowGroup Id="">
      
        ...
      
        </RowGroup>
      </RowGroups>
    </Structure>
  </Structures>
  <Outbuildings>
    <Outbuilding OutbuildingType=""
                 OutbuildingTypeOtherDescription="">
      <RowGroups>
        <RowGroup Id="">
      
        ...
      
        </RowGroup>
      </RowGroups>
    </Outbuilding>
  </Outbuildings>
</ReportFields>

RowGroup Attributes

Attribute Conditionality Description
Id Conditionally Required Unique identifier for the row group. Omitted for the base/unnamed row group (see below).
DynamicTextField Element

The DynamicTextField element represents text fields on dynamic forms. A given text field's Id can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if a text field's DynamicTextField element is omitted completely, its Data attribute is omitted from its DynamicTextField element, or its Data attribute is set to "xsi:nil", that text field will be ignored by the import process. If its Data attribute is set to empty text or white space and Overwrite populated fields is selected in the import dialog, that text field will be cleared.

<RowGroups>
  <RowGroup>
    <Fields>
      <DynamicTextField Id="" Data="" />
    </Fields>
  </RowGroup>
</RowGroups>
Attribute Conditionality Description
Id Required Unique identifier for the field.
Data Optional The value for this field. Must be text.
DynamicCheckBoxField Element

The DynamicCheckBoxField element represents check box fields on dynamic forms. A given check box field's Id can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if a check box field's DynamicCheckBoxField element is omitted completely, its Data attribute is omitted from its DynamicCheckBoxField element, or its Data attribute is set to "xsi:nil", that check box field will be ignored by the import process. If its Data attribute is set to false and Overwrite populated fields is selected in the import dialog, that check box field will be erased.

<RowGroups>
  <RowGroup>
    <Fields>
      <DynamicCheckBoxField Id="" Data="" />
    </Fields>
  </RowGroup>
</RowGroups>
Attribute Conditionality Description
Id Required Unique identifier for the field.
Data Optional The value for this field. Must be "true" (checked) or "false" (unchecked).
DynamicImageField Element

The DynamicImageField element represents single image fields on dynamic forms. A given image field's Id can be looked up in Appraise-It Pro's Field Details pane.

When importing an RPTI file into an existing report in Appraise-It Pro, if an image field's DynamicImageField element is omitted completely, its Data attribute is omitted from its DynamicImageField element, or its Data attribute is set to "xsi:nil", that image field will be ignored by the import process. If its Data attribute is set to empty text or white space and Overwrite populated fields is selected in the import dialog, that image field will be erased.

<RowGroups>
  <RowGroup>
    <Fields>
      <DynamicImageField Id="" SignatureType="" Data="" />
    </Fields>
  </RowGroup>
</RowGroups>
Attribute Conditionality Description
Id Required Unique identifier for the field.
SignatureType Optional For fields associated with a signature. Defaults to None.Note
Data Optional The unique identifier of the image file as it appears in the Images element.
DynamicImageListField Element

The DynamicImageListField element represents grouped image fields on dynamic forms. A given image field group's Id can be looked up in Appraise-It Pro's Field Details pane by selecting its associated Add/Remove Images button.

A DynamicImageListField element contains a single Data child element, which itself can contain any number of ImageReference child elements.

When importing an RPTI file into an existing report in Appraise-It Pro, if an image field's DynamicImageField element is omitted completely, its Data attribute is omitted from its DynamicImageField element, or its Data attribute is set to "xsi:nil", that image field will be ignored by the import process. If its Data attribute is set to empty text or white space and Overwrite populated fields is selected in the import dialog, that image field will be erased.

<RowGroups>
  <RowGroup>
    <Fields>
      <DynamicImageListField Id="" SignatureType="">
        <Data>
          <ImageReference Label="" PrintLayout="" />
        </Data>
      </DynamicImageListField>
    </Fields>
  </RowGroup>
</RowGroups>

DynamicImageListField Attributes

Attribute Conditionality Description
Id Required Unique identifier for the field.
SignatureType Optional For fields associated with a signature. Defaults to None.Note

ImageReference Attributes

Attribute Conditionality Description
Id Required The unique identifier of the image file as it appears in the Images element.
Label Optional A description of the image as defined in the ImageCategoryType enumeration. Defaults to "None" if omitted.
PrintLayout Optional The image frame size to use when printing the report. Defaults to "BestFit" if omitted.

Valid values for ImageReference Label attributes are:

  • None
  • AbsorptionRateGraph
  • AssignmentExhibit
  • CompletedConstruction
  • CostApproachExhibit
  • DisasterMitigationExhibit
  • DwellingExteriorExhibit
  • DwellingFront
  • DwellingRear
  • Encroachment
  • EnergyEfficientAndGreenFeaturesExhibit
  • FloorPlan
  • FunctionalObsolescenceExhibit
  • GrossRentMultiplierComparableMap
  • HighestAndBestUseExhibit
  • IncomeApproachExhibit
  • LandComparableMap
  • LegalDescription
  • ManufacturedHomeExhibit
  • ManufacturedHomeFinancingProgramEligibilityCertification
  • ManufacturedHomeHUDCertificationLabel
  • ManufacturedHomeHUDDataPlate
  • MarketAnalysisExhibit
  • MedianDaysOnMarketGraph
  • NoncontinuousArea
  • NonResidentialUse
  • OutbuildingExhibit
  • PercentOfDistressedSalesGraph
  • PermanentWaterfrontFeature
  • PriceTrendGraph
  • PriorSaleAndTransferHistoryExhibit
  • ProjectAmenity
  • ProjectDeficiency
  • ProjectExhibit
  • PropertyAccess
  • PropertyBoundaries
  • YearBuiltOfSalesGraph
  • ReconciliationExhibit
  • RentalComparableMap
  • RentalInformationExhibit
  • SalesComparableMap
  • SalesComparisonApproachExhibit
  • SalesContractExhibit
  • SiteCharacteristic
  • SiteExhibit
  • SiteInfluence
  • SubjectListingExhibit
  • SubjectPropertyAmenitiesExhibit
  • SubjectPropertyExhibit
  • SubjectPropertyImprovementSketch
  • SupplementalExhibit
  • UnitInteriorExhibit
  • ValuationCompletionExhibit
  • ValuationUpdateExhibit
  • VehicleStorageExhibit
  • View
  • WaterFrontage

Valid values for ImageReference PrintLayout attributes are:

  • BestFit (Appraise-It Pro will automatically select the best image frame size for the image)
  • Photos (sized to fit 8 images per legal page in a 2x4 grid)
  • Graphs (sized to fit 3 images per legal page stacked vertically)
  • FullPage (sized to fit 1 image filling a legal page)
NestedRowGroup Element

A NestedRowGroup element is precisely what it sounds like: a row group inside a RowGroup. A given nested row group's Id can be looked up in Appraise-It Pro's Field Details pane.

A NestedRowGroup can contain any number of four possible child elements: DynamicTextField, DynamicCheckBoxField, DynamicImageField, and DynamicImageListField. (It cannot contain another NestedRowGroup.)

<RowGroups>
  <RowGroup>
    <Fields>
      <NestedRowGroup NestedRowGroupId="">
        <Fields>
          <DynamicCheckBoxField />
          <DynamicTextField />
          <DynamicImageField />
          <DynamicImageListField>
            <Data>
              <ImageReference />
            </Data>
          </DynamicImageListField>
        </Fields>
      </NestedRowGroup>
    </Fields>
  </RowGroup>
</RowGroups>
Attribute Conditionality Description
NestedRowGroupId Required Unique identifier for the nested row group.
Structures Element

The Structures element contains any number of Structure child elements.

Structure elements contain LivingUnits, Adus, and RowGroups child elements. The LivingUnits element contains Unit child elements; the Adus element contains Adu child elements.

<Structures>
  <Structure Name="">
    <RowGroups>
      <RowGroup Id="">
        <Fields />
      </RowGroup>
    </RowGroups>
    <LivingUnits>
      <Unit Name="">
        <RowGroups />
      </Unit>
    </LivingUnits>
    <Adus>
      <Adu Name="">
        <RowGroups />
      </Adu>
    </Adus>
  </Structure>
</Structures>

Structure Attributes

Attribute Conditionality Description
Name Conditionally Required The name of the structure (dwelling). May only be empty if the property contains only one structure. Must be unique for the property it applies to.
IsManufacturedHome Required Indicates whether the associated structure is a manufactured home. Must be "true" or "false".
LivingUnits Element and Children

LivingUnits is a list of living units contained within the parent structure.

Each Unit element contains a RowGroups child element.

<Structures>
  <Structure Name="">
    <LivingUnits>
      <Unit Name="">
        <RowGroups />
      </Unit>
    </LivingUnits>
  </Structure>
</Structures>

Unit Attributes

Attribute Conditionality Description
Name Conditionally Required The name of the unit. Required if the property has more than one living unit or has an ADU. Must be unique for the property it applies to.
Adus Element and Children

Adus is a list of accessory dwelling units contained within the parent structure.

Each Adu element contains a RowGroups child element.

<Structures>
  <Structure Name="">
    <Adus>
      <Adu Name="">
        <RowGroups />
      </Adu>
    </Adus>
  </Structure>
</Structures>

Adu Attributes

Attribute Conditionality Description
Name Required The name of the accessory dwelling unit. Must be unique for the property it applies to.
Outbuildings Element

The Outbuildings element contains any number of Outbuilding child elements.

Outbuilding elements contain Adus and RowGroups child elements. The Adus element contains Adu child elements.

<Outbuildings>
  <Outbuilding OutbuildingType=""
               OutbuildingTypeOtherDescription="">
    <RowGroups>
      <RowGroup Id="">
        <Fields />
      </RowGroup>
    </RowGroups>
    <Adus>
      <Adu Name="">
        <RowGroups />
      </Adu>
    </Adus>
  </Outbuilding>
</Outbuildings>

Outbuilding Attributes

Attribute Conditionality Description
OutbuildingType Required The type of outbuilding as defined in the OutbuildingType enum.
OutbuildingTypeOtherDescription Conditionally Required A description of the outbuilding when OutbuildingType is "Other".

Valid values for the OutbuildingType attribute are:

  • None
  • Barn
  • Boathouse
  • Bunkhouse
  • EnclosedKennel
  • Greenhouse
  • GuestHouse
  • IndoorRidingArena
  • ManufacturedHome
  • Office
  • Other
  • PoolHouse
  • Shed
  • Silo
  • Stable
  • StandaloneAdu
  • Studio
  • Workshop

CompFields Element and Children

The second child element of DynamicFields is CompFields, which contains one CompGrid child element for each type of comp in the report.

CompGrid elements contain any number of Comp child elements, which themselves can contain RowGroups, Structures, and Outbuildings elements.

<CompFields>
  <CompGrid CompType="">
    <Comp>
      <RowGroups />
      <Structures />
      <Outbuildings />
    </Comp>
  </CompGrid>
</CompFields>

CompGrid Attributes

Attribute Conditionality Description
CompType Required This is the type of the comparable in the grid (i.e. "SalesComparables" or "GrmComparables").

Note that CompGrid does not support rental comps. For rental comps, use the RentalFields element.

RentalFields Element and Children

The third child element of DynamicFields is RentalFields, which contains any number of Rental child elements.

Rental elements contain RowGroups and ComparisonFields child elements; ComparisonFields elements contain any number of SubjectUnit child elements, which contain a RowGroups element for rental field data.

<RentalFields>
  <Rental>
    <RowGroups>
        <RowGroup Id="">
          <Fields />
        </RowGroup>
    </RowGroups>
    <ComparisonFields>
      <SubjectUnit SubjectStructureIndex=""
                   SubjectStructureLivingUnitIndex=""
                   SubjectStructureAduIndex=""
                   SubjectOutbuildingIndex=""
                   SubjectOutbuildingAduIndex=""
                   UsedForComparison="">
        <RowGroups>
          <RowGroup Id="">
            <Fields />
          </RowGroup>
        </RowGroups>
      </SubjectUnit>
    </ComparisonFields>
  </Rental>
</RentalFields>
SubjectUnit Elements

A SubjectUnit element allows for comparing the rental with a specific subject unit.

Attribute Conditionality Description
SubjectStructureIndex Conditionally Required The index of the subject unit's structure.

-1 indicates the unit is not found in a structure.
SubjectStructureLivingUnitIndex Conditionally Required The index of the subject living unit.

-1 indicates the unit is not a living unit.
SubjectStructureAduIndex Conditionally Required The index of the subject ADU, if the ADU is part of a structure.

-1 indicates the unit is not an ADU as part of a structure.
SubjectOutbuildingIndex Conditionally Required The index of the subject unit's outbuilding.

-1 indicates the unit is not found in an outbuilding.
SubjectOutbuildingAduIndex Conditionally Required The index of the subject ADU, if the ADU is part of an outbuilding.

-1 indicates the unit is not an ADU as part of an outbuilding.
UsedForComparison Optional Indicates if the subject living unit is used for comparison with this rental. Must be "true" or "false"; defaults to "false".

Images Element and Children

The fourth child element of DynamicFields is Images, which contains any number of Image child elements.

Image elements may contain Elevation and Location child elements.

<Images>
  <Image Id="" FileName="" Caption="" CreationDateTime="">
    <Elevation Value="" Units="" />
    <Location Latitude="" Longitude="" />
  </Image>
</Images>
Attribute Conditionality Description
Id Required A numeric unique identifier for the image. DynamicImageFields and DynamicImageListFields use this identifier to reference the image.
FileName Required The name of the image file, in the Images folder within the RPTI container file.
Caption Optional A description of the image.
CreationDateTime Optional The date and time the photo was taken. Leave blank if unknown.

Any provided value should be parsable as a .NET DateTime.
Elevation Element

An Elevation element reports the elevation at which the photo was taken.

Attribute Conditionality Description
Value Required The elevation's numeric value as a whole number.
Units Required The unit of measure for the elevation.

Supported units of measure for elevations are:

  • Feet
  • Kilometers
  • Meters
  • Miles
Location Element

A Location element reports the GPS coordinates at which the photo was taken.

Attribute Conditionality Description
Latitude Required The location's numeric latitude.
Longitude Required The location's numeric longitude.