Technical¶
Components¶
hemnet consists of the following components:
- Data structure (existing + new tables and fields) in Lime CRM
- Python package
- Commands and Web components for web client usage
- Actionpad app for desktop client usage
Table and Field Definitions Lime CRM¶
Table mapped to Hemnet's project¶
| db name | Field type | Comment |
|---|---|---|
| hemnet_id | string (length 32) | Readonly |
| hemnet_status | option | Readonly, see options below. |
| hemnet_error | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
| hemneturl | link (length 128) | Readonly |
| pictures | relation (hasmany) | Real Estate standard pictures table |
Table mapped to Hemnet's projectunit¶
This part is related to the publishing of projectunit
| db name | Field type | Comment |
|---|---|---|
| hemnet_id_project | string (length 32) | Readonly |
| hemnet_status_project | option | Readonly, see options below. |
| hemnet_error_project | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
| hemnet_status_featured | option | Readonly, see options below. |
| hemnet_error_featured | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
| hemneturl_project | link (length 128) | Readonly |
| middle_picture | relation (hasmany) | Real Estate standard middle_picture table |
Table mapped to Hemnet's listing¶
This part is related to the publishing of listing
Can be the same table as the table that is mapped to projectunit.
| db name | Field type | Comment |
|---|---|---|
| hemnet_id_listing | string (length 32) | Readonly |
| hemnet_status_listing | option | Readonly, see options below. |
| hemnet_error_listing | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
| hemneturl_listing | link (length 128) | Readonly |
| middle_picture | relation (hasmany) | Real Estate standard middle_picture table |
Table mapped to Hemnet's showing related to projectunit¶
| db name | Field type | Comment |
|---|---|---|
| hemnet_id_unit | string (length 32) | Readonly |
| hemnet_status_projectunit | option | Readonly, see options below. |
| hemnet_error_projectunit | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
Table mapped to Hemnet's showing related to listing¶
| db name | Field type | Comment |
|---|---|---|
| hemnet_id_listing | string (length 32) | Readonly |
| hemnet_status_listing | option | Readonly, see options below. |
| hemnet_error_listing | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
Additional fields needed on pictures¶
| db name | Field type | Comment |
|---|---|---|
| publishon | option | The option key hemnet needs to be added |
| hemnet_id | string (length 32) | Readonly Hidden |
| hemnet_status | option | Readonly, see options below. |
| hemnet_error | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
Additional fields needed on middle_picture¶
| db name | Field type | Comment |
|---|---|---|
| publishon | option | The option key hemnet needs to be added |
| hemnet_id_projectunit | string (length 32) | Readonly Hidden |
| hemnet_status_projectunit | option | Readonly, see options below. |
| hemnet_error_projectunit | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
| hemnet_id_listing | string (length 32) | Readonly Hidden |
| hemnet_status_listing | option | Readonly, see options below. |
| hemnet_error_listing | string (length 256) | Readonly. Populated with error message if hemnet_status is error_publish or error_unpublish. |
Hemnet Status Options¶
| Key | Description |
|---|---|
empty |
|
published |
The object is published to Hemnet. |
unpublished |
The object has been unpublished from Hemnet. |
error_publish |
Something went wrong while publishing. |
error_unpublish |
Something went wront while unpublishing. |
Python package¶
- Endpoints
Commands¶
Publish project units¶
limepkg_hemnet.bulk-publish-units
This action publishes all selected project units, will also publish the project if it is not already published. Avalaible to use as bulk action.
Set project units as featured¶
limepkg_hemnet.publish-feature-units
This action will set all selected project units as featured on Hemnet. To be able to set a project unit as featured, the project unit must be published to Hemnet. The command therefore checks that all selected project units are published to Hemnet.
Hemnet has a limit of 5 featured project units for a project, this action therefore checks that there are not more than 5 project units selected (together with already featured project units).
Avalaible to use as bulk action and custom action (on the project unit).
Remove project units as featured¶
limepkg_hemnet.unpublish-feature-units
This action will remove all selected project units as featured on Hemnet. Avalaible to use as bulk action and custom action (on the project unit).
Unpublish project¶
limepkg_hemnet.unpublish-project
This action will unpublish the project together with all related project units, images and showings. Avalaible to use as custom action (on the project).
Unpublish project unit¶
limepkg_hemnet.unpublish-unit
This action will unpublish the project unit together with all related images and showings. Avalaible to use as custom action (on the project unit).
Web components¶
TODO