Description
The Metadata transaction is used to retrieve information about the structure and definitions of the data available through the MLS® IDX API. Metadata allows clients to properly format listing data for display and to organize it efficiently for future retrieval and storage.
End Point
https://sample.mlsidxapi.com/Metadata.svc/GetMetadata| Argument | Type | Description | Default | Required | Supported Values |
|---|---|---|---|---|---|
| Type | String | Selects the type of metadata to be returned | RETS 1.7.2 | METADATA-SYSTEM METADATA-RESOURCE METADATA-CLASS METADATA-LOOKUP METADATA-LOOKUP_TYPE | |
| Format | String | Selects the supported data return format for the query response | STANDARD-XML | STANDARD-XML COMPACT | |
| ID | String | List of the names of the parent elements for the desired element, separated by colons Resource:Lookup Eg; Property:MesureUnit | 0 – request for all Type metadata contained within that level *. – request is for all Type metadata contained within that level and within the requested Type (i.e. all metadata) Resource:Class | ||
| Culture | String | Select the language of the results | en-CA | en-CA fr-CA |
Note: The metadata ID for METADATA-SYSTEM and METADATA-RESOURCE must be 0 or *.
Note: METADATA-LOOKUP and METADATA-LOOKUP_TYPE requests only support STANDARD-XML format
Metadata Examples
| Action | Syntax |
|---|---|
| Retrieve all Resource metadata, all levels | Type=METADATA RESOURCE&Format=COMPACT&ID=* |
| Retrieve all Class metadata, class level only | Type=METADATA CLASS&Format=COMPACT&ID=* |
| Retrieve Class metadata for a specific resource | Type=METADATA CLASS&Format=COMPACT&ID=Property |
| Retrieve Table metadata for a specific resource and class | Type=METADATA TABLE&Format=COMPACT&ID=Property:Property |
| Retrieve Lookup metadata for a specific resource | Type=METADATA-LOOKUP&Format=STANDARD- XML&ID=Property |
| Retrieve Lookup metadata for a specific resource and lookup type | Type=METADATA LOOKUP_TYPE&Format=STANDARD XML&ID=Property:Crop |
Server Response Header Fields
| Request Argument | Type | Description | Default | Required | Supported Values |
|---|---|---|---|---|---|
| Content-type | String | Media type of the underlying data | RETS 1.7.2 | text/xml |