OnOffice Estate

Work with OnOffice estate/property records

Actions4

Overview

This node interacts with the OnOffice real estate API to manage estate/property records. Specifically, the "Find" operation allows users to retrieve detailed information about a single estate by its unique ID. This is useful in scenarios where you need to fetch specific property details for further processing, reporting, or integration with other systems.

Practical examples include:

  • Retrieving full details of a property to display on a website or app.
  • Fetching an estate's data to update or synchronize with another database.
  • Using the estate information as part of an automated workflow, such as sending notifications or generating reports.

Properties

Name Meaning
Estate ID The unique identifier of the estate to find.
Fields to Return Select which fields of the estate record to return. Options include:
- ID
- External Object Number
- Title
- Type of Marketing
- Property Type
- Purchase Price
- Cold Rent
- Living Space
- Number of Rooms
- Postal Code
- City
- Street
- House Number
- Description
- Creation Date
- Last Change Date
- Status

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the operation was successful.
  • operation: The operation performed, here it will be "find".
  • data: An array of estate records matching the query. For the "Find" operation, this typically contains one record with the requested fields.
  • total (optional): Total number of records found (mainly relevant for multiple results).
  • message (optional): Informational message from the API, especially after create or update operations.

Example output JSON snippet:

{
  "success": true,
  "operation": "find",
  "data": [
    {
      "Id": "12345",
      "objektnr_extern": "EXT-6789",
      "objekttitel": "Beautiful Family Home",
      "vermarktungsart": "kauf",
      "objektart": "haus",
      "kaufpreis": 350000,
      "kaltmiete": 0
      // ... other requested fields
    }
  ]
}

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of these credentials within n8n is necessary for the node to function.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Estate ID will result in no data or an error response.
    • Selecting fields that do not exist or are not accessible may lead to incomplete data or errors.
    • Network connectivity problems can prevent API communication.

  • Error messages:

    • "OnOffice API action error: <message>" indicates the API returned an error related to the request parameters or resource state.
    • "OnOffice API error: <message>" suggests a more general API failure, possibly due to authentication or server issues.

  • Resolution tips:

    • Verify API credentials are correctly set up and valid.
    • Double-check the Estate ID used exists in the OnOffice system.
    • Ensure selected fields are valid and available for the estate.
    • Check network access and firewall settings allowing outbound HTTPS requests.

Links and References

Discussion