Context
Let’s say you have a website for a community called “Bluestone” and you want to add LotWorks Maps so you can display dynamic lot inventory statuses. For our examples here, everything in blue is served up by LotWorks. Everything in green is your own content, and is hosted by you, on your website.
Here’s a mockup of your new website page called Lot Map. You’ve embedded the LotWorks map on this page with a few lines of code. The side panel opens when a customer clicks on a lot in the map.
The Default Side Panel
The default content in the LotWorks Maps side panel displays the lot fields (e.g address, frontage etc.) in simple text format. If you opt for the default side panel, you don’t have to do anything else: this content will automatically appear.
Custom Side Panel
Opting for a custom side panel allows you to display completely custom content. Typically this is a new website page built by your web team specifically for displaying dynamic content within the context of the side panel. (For the tech-savvy: the darker green panel is an embedded iframe.)
Usage
You (and/or your web developers) will need to ensure you have one page that is designed to receive all calls from the LotWorks map and then serve up your custom content. You will tell us what the URL for this page is, and we will then call that page when a customer clicks on a lot. When we call this page, we will also pass you information on the lot in the form of “parameters.” You will use these parameters to decide what content to show.
For example, let’s say this is the website address for your new community:
www.liveinbluestone.com
You might create a new page to handle side panel content and give it an SEO-friendly address like:
www.liveinbluestone.com/lot-details/
We would register this URL in LotWorks Maps, and add any parameters to it that you’d want to receive (see below for a complete list of available parameters):
www.liveinbluestone.com/lot-details/?lotaddress={{lotaddress}}&lotstatus={{lotsstatus}}&producttype={{producttype}}
Then, when a customer clicks on a specific lot, we’d call your page like this:
If the customer clicked on a different lot that had, for example, lotstatus=Quick%20Possession, you might choose instead to show a picture of that Quick Possession home, pricing, and a link to more details elsewhere on your website.
Important URL Rules
We allow one same programmatic URL which can be based on a various data.
liveinbluestone.com/lot-details?status={{lotstatus_slug}}
√ liveinbluestone.com/lot-details?status=available
√ liveinbluestone.com/lot-details?status=sold
OR
liveinbluestone.com/lot-details/{{lotstatus_slug}}
√ liveinbluestone.com/lot-details/available
√ liveinbluestone.com/lot-details/sold
We cannot have multiple handcrafted URLs that have different structure:
✗ liveinbluestone.com/available/mylot
AND
✗ liveinbluestone.com/lot-details/belmont/sold
If you have concerns regarding your URL structure we are happy to answer any questions before you go ahead and complete it.
Mapping Lots to Home Models
IMPORTANT: LotWorks Maps does not store any information about specific home models. Nor is it capable of storing specific custom URLs to be called for each individual lot. We store one global URL that will be called for any lot the customer clicks on. That means the side panel page you create must be capable of receiving parameters (either through GET or POST) and then programmatically re-routing the request to the appropriate content. You’ll likely have to rely on one or more of lot sales status, product type, and build pocket to determine what content to show.
To date, we have found a combination of these three fields has been sufficient to allow you to map lots to models, but if your needs are more complex, we do have an option for you to export your Lot IDs and directly map them to models in your own database.
Additional Notes
- There are many ways you can set up and organize your custom page; the above is a simple example.
- All custom content has to be returned using the secure HTTPS protocol.
- The accuracy and completeness of the data we pass to you is determined by the information submitted to LotWorks by builders and/or developers and is not controlled by Blueprint.
- The content returned should only include the side panel content itself and should not include your standard website header or footer.
Lot Parameter Details
A list of available fields you can expect we'll pass you as parameters when calling your custom content URL:
Available Fields |
Example |
|
lotid |
string A unique lot identifier. |
‘lw-qce-1508’ |
community |
string The name of the community that contains the lot. |
‘Bluestone’ |
phase |
string The name of the phase that contains the lot. |
‘9A’, ‘4’ or ‘06’ |
block |
string The name of the block that contains the lot. |
‘2’ or ‘06’ |
lotnumber |
string The number of the lot in the block. Note: This is not the home address number. |
‘44’, ‘6’ or ‘104’ |
lotaddress |
string The street address of the lot. |
‘123 Any Street’ |
lotstatus |
string The current status of the lot from a customizable list. |
‘Available’, ‘Showhome’, ‘Spec’, ‘Sold’, or ‘Not Available’. |
lkp_lotstatus |
Number or array of numbers See "Lot Status ID Values" below for the fixed value list. |
"lkp_lotstatus":[1,3] |
producttype |
string The product type of the lot from a customizable list. |
‘Laned’ or ‘Front Garage’ |
frontage |
number The total frontage of the lot. |
40.6, 30.0 or 50 |
buildpocket |
number The maximum width of the home that can be built on the lot. This is usually 8ft less than the frontage. |
32.6, 22.0 or 42 |
Lot Status ID Values | |
Values are fixed and typically available for all Maps. Recommended to use this for any business logic as it is standardized across all clients (whereas lotstatus string can be different by client). Use the id value to filter as the label is subject to minor changes. |
|
1 | Available |
2 | On-Hold |
3 | Sold |
5 | Showhome |
6 | Not Available |
7 | Spec |
9 | Conditionally Sold |
-100 |
Not Applicable i.e. Not Set |
Standardized Product Type Details
A list of available product type fields can be found below. These are part of the LotWorks Better Data Initiative with the ultimate goal of greatly improving data quality and reporting within LotWorks.
Usage
lkp_stdproducttype |
number See "Standardized Product Types" below for the fixed value list. |
Standardized Product Types |
|
id value is passed to Custom Side Panel as the label is subject to minor changes. |
|
1 |
Single Family Front |
2 |
Single Family Rear |
3 |
Single Family Front - Estate |
4 |
Single Family Front - Zero Lot Line |
5 |
Single Family Rear - Zero Lot Line |
20 |
Duplex Front |
21 |
Duplex Rear |
40 |
Row Home |
41 |
Townhome |
60 |
Condo |
99 |
Other |
-100 |
Not Applicable i.e. Not Set |
Comments
0 comments
Please sign in to leave a comment.