Overview
This node interacts with the onOffice API to manage real estate data. Specifically, the "Estate" resource with the "Get" operation retrieves detailed information about a single estate by its ID. Users can specify which fields of the estate they want to include in the response, allowing for tailored data retrieval.
Common scenarios where this node is beneficial include:
- Fetching detailed information about a specific property listing for display or processing.
- Integrating estate data into CRM systems or websites.
- Automating workflows that require up-to-date property details from onOffice.
Example: Retrieve an estate's title, price, and address by providing its unique Estate ID and selecting those fields.
Properties
| Name | Meaning |
|---|---|
| Estate ID | The unique identifier of the estate to retrieve. This is required. |
| Fields | Select one or more fields to include in the response. Options are: |
| - Object Number (objektnr_extern) | |
| - Title (objekttitel) | |
| - Description (objektbeschreibung) | |
| - Price (kaufpreis) | |
| - Living Space (wohnflaeche) | |
| - Plot Area (grundstuecksflaeche) | |
| - Number of Rooms (anzahl_zimmer) | |
| - Address (strasse) | |
| - Postal Code (plz) | |
| - City (ort) | |
| - Country (land) |
Output
The output is a JSON object representing the requested estate data as returned by the onOffice API. It includes the fields specified in the input properties, structured according to the API's response format.
If multiple estates were retrieved (not applicable for the "Get" operation), the output would be an array of such objects. For the "Get" operation, a single JSON object is returned inside an array.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the onOffice API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The node sends POST requests to the
/api.phpendpoint of the onOffice API with specific action identifiers.
Troubleshooting
Common issues:
- Invalid or missing Estate ID will cause the API request to fail.
- Selecting no fields may result in minimal or empty data returned.
- Network or authentication errors if the API key credential is not set correctly.
Error messages:
- Errors from the API will be thrown and can be caught if "Continue On Fail" is enabled.
- Typical error messages might include "Estate not found" or "Unauthorized access".
Resolutions:
- Verify the Estate ID is correct and exists in the onOffice system.
- Ensure the API key credential is valid and has necessary permissions.
- Confirm network connectivity to the onOffice API endpoint.
Links and References
- onOffice API Documentation (general reference for API usage)
- n8n documentation on creating custom nodes