Flexmls: Mapping: Layers
The Flexmls: Mapping: Layers service provides the tile layers available on the flexmls map server.
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
All Layers
/<API Version>/flexmls/mapping/layers
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns all layers available to the user. | 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:
Parameter | Required | Notes |
---|---|---|
Standard search and paging syntax | No |
GET Response
{
"D": {
"Results": => [
{
"Id"=>"2021010511111111111000000",
"ResourceUri"=>"/v1/flexmls/mapping/layers/2021010511111111111000000",
"MlsId"=>"20210105000000000000000000",
"LayerName"=>"counties",
"Description"=>"Counties",
"Legends"=>[]
},
{
"Id"=>"2021010522222222222000000",
"ResourceUri"=>"/v1/flexmls/mapping/layers/2021010522222222222000000",
"MlsId"=>"20000426143505724628000000",
"LayerName"=>"us_flood_zones",
"Description"=>"FEMA Flood Zones",
"Legends"=> [
{"Color"=>"FA928F", "Description"=>"A: Detailed analysis not performed. 26% chance over 30yr mortgage"},
{"Color"=>"C7AB8F", "Description"=>"AE: Base elevations are provided. 26% chance over 30yr mortgage"},
{"Color"=>"FABFE7", "Description"=>"AH: Pond flood hazard"},
{"Color"=>"C2928F", "Description"=>"AO: River or stream flood hazard"},
{"Color"=>"BFFFCF", "Description"=>"V: Flooding with wave hazard. Base elevations not provided"},
{"Color"=>"7EE3E3", "Description"=>"VE: Flooding with wave hazard"}
]
}
],
"Success": true
}
}
Individual Layers
/<API Version>/flexmls/mapping/layers/<Layer.Id>
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns a specified Layer record | 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": {
"Results": => [
{
"Id"=>"2021010522222222222000000",
"ResourceUri"=>"/v1/flexmls/mapping/layers/2021010522222222222000000",
"MlsId"=>"20000426143505724628000000",
"LayerName"=>"us_flood_zones",
"Description"=>"FEMA Flood Zones",
"Legends"=> [
{"Color"=>"FA928F", "Description"=>"A: Detailed analysis not performed. 26% chance over 30yr mortgage"},
{"Color"=>"C7AB8F", "Description"=>"AE: Base elevations are provided. 26% chance over 30yr mortgage"},
{"Color"=>"FABFE7", "Description"=>"AH: Pond flood hazard"},
{"Color"=>"C2928F", "Description"=>"AO: River or stream flood hazard"},
{"Color"=>"BFFFCF", "Description"=>"V: Flooding with wave hazard. Base elevations not provided"},
{"Color"=>"7EE3E3", "Description"=>"VE: Flooding with wave hazard"}
]
}
],
"Success": true
}
}
Layers Description
Attribute | Data Type | Description |
---|---|---|
Id |
Character | The unique id for the Layer. |
ResourceUri |
Character | The URI to the Layer. |
MlsId |
Character | The ID for the MLS to which the Layer belongs. |
LayerName |
Character | The name of the Layer on the map server. |
Description |
Character | The human-readable name for the Layer. |
Legends |
Array of JSON Objects | Additional information associated with shapes within the layer, if present. |
Legends[n].Description |
Character | The name associated with a shape within the Layer, if present |
Legends[n].Color |
Character | The color associated with the named shape within the Layer, if present. |
Expansions
None.
API Explorer
Interact with this service using the API Explorer.