Flexmls: Listing Meta Translations
This service provides a dictionary that translates standard and custom fields to their corresponding field data used by Flexmls Web.
- Supported Roles
- Available Services
- Flexmls: Listing Meta Translations Description
- Expansions
- API Explorer
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | No |
More information about roles may be found here.
Available Services
Translations for a Property Type
/<API Version>/flexmls/propertytypes/<PropertyType.MlsCode>/translations
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the translations for all standard and custom fields | No | |
| POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| PUT | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| DELETE | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [{
"StandardFields": {
"City": {
"FlexmlsTableName": "list",
"FlexmlsFieldId": "city",
"FlexmlsDisplayId": "20100000000000000000000000",
"FlexmlsDisplayType": "T",
"FlexmlsGroupId": null,
"SparkDataType": "Character"
},
"BedsTotal": {
"FlexmlsTableName": "list",
"FlexmlsFieldId": "total_beds",
"FlexmlsDisplayId": "20100000000000000000000001",
"FlexmlsDisplayType": "N",
"FlexmlsGroupId": null,
"SparkDataType": "Integer"
},
"ListPrice": {
"FlexmlsTableName": "list",
"FlexmlsFieldId": "list_price",
"FlexmlsDisplayId": "20100000000000000000000002",
"FlexmlsDisplayType": "N",
"FlexmlsGroupId": null,
"SparkDataType": "Decimal"
}
},
"CustomFields": {
"General Property Description": {
"Direction": {
"FlexmlsTableName": "list",
"FlexmlsFieldId": "userdefined4",
"FlexmlsDisplayId": "20100000000000000000000003",
"FlexmlsDisplayType": "S",
"FlexmlsGroupId": "20100000000000000000000004",
"SparkDataType": "Character"
}
}
}
}]
}
}
Flexmls: Listing Meta Translations Description
| Attribute | Data Type | Description |
|---|---|---|
FlexmlsTableName |
Character | The grouping the FlexmlsFieldId falls under in flexmls Web. This will typically be one of the following: list, feature, or report. |
FlexmlsFieldId |
Character | The unique field name for the FlexmlsTableName. |
FlexmlsDisplayId |
Character | The GUID for the field. |
FlexmlsDisplayType |
Character | The 'display' table type for the field in flexmls web. Possible values: D (date), I (integer), N (decimal), S (scroll/field list), T (text), Y (boolean). |
FlexmlsGroupId |
Character | The GUID for the group the field belongs to. |
SparkDataType |
Character | The Spark® data type for this field. |
Expansions
None.
API Explorer
Interact with this service using the API Explorer.