Where to find documentation for the RETS data returned

edit

This is where the RETS metadata comes in. It is used to describe the data being returned.

Using L_Keyword1 as an example we see that it contains Water Frontage information:

<metadata-table system="LAAR" resource="Property" class="RE_1" version="16.2.37045" date="2016-02-25T17:25:08.1Z"> <field> <systemname>L_Keyword1</systemname> <longname>Water Frontage</longname> <dbname>WtrFrntg</dbname> <shortname>Wtr Frntg</shortname> <interpretation>Lookup</interpretation> <lookupname>Keyword_1_1</lookupname> ... </field> </metadata-table>

We also see that it has a lookup Keyword_1_1 attached to it. In the lookup we see values like this:

<rets replycode="0" replytext="SUCCESS" &gt;="" <metadata=""> <metadata-lookup_type system="LAAR" resource="Property" lookup="ACCESS_Lkp_5" version="16.2.37049" date="2016-02-25T17:29:19.4Z"> <lookuptype> <longvalue>City Street</longvalue> <shortvalue>CS</shortvalue> <value>996</value> </lookuptype> <lookuptype> <metadataentryid>017508F1D765FF070002</metadataentryid> <longvalue>County Road</longvalue> <shortvalue>CNR</shortvalue> <value>997</value> </lookuptype> ... </metadata-lookup_type> </metadata> </rets>

When searching, data can be returned in different formats: Format=COMPACT - Returns data indicated by "Value" in the lookup. Format=COMPACT-DECODED - Returns the decoded lookup value which is the "LongValue" for the field as shown in the lookup data.

In the field data Interpretation can also be set to LookupMulti, which means the field can have multiple values assigned. If there are multiple values assigned to a field, a comma separated set of values would be returned of either "Value" or "LongValue" depending on the format specified.