OnOffice Estate

Work with OnOffice estate/property records

Actions4

Overview

The node "OnOffice Estate" allows users to interact with OnOffice's real estate/property records via their API. Specifically, the "Find Many" operation enables retrieving multiple estate records based on various filters and criteria. This is useful for scenarios where you want to query a list of properties matching certain conditions, such as all apartments for rent in a specific city or houses for sale within a price range.

Practical examples include:

  • Fetching a list of available apartments for rent in Berlin with at least 3 rooms.
  • Retrieving commercial properties for sale with a purchase price less than a specified amount.
  • Getting estates filtered by postal code and marketing type, limiting results for pagination.

Properties

Name Meaning
Fields to Return Select which fields of the estate records to include in the output. Options include ID, 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. Default includes common fields like ID, External Object Number, Title, etc.
Filters Add one or more filters to narrow down the search results. Each filter consists of:
- Field: Property attribute to filter by (e.g., Property Type, Marketing Type, City, Postal Code, Purchase Price, Cold Rent, Living Space, Number of Rooms, Status).
- Operator: Comparison operator ("Equals", "Contains", "Greater Than", "Less Than").
- Value: The value to compare against.
Multiple filters can be combined.
Property Type Filter results by property type. Options: Any, House, Apartment, Land, Commercial.
Marketing Type Filter results by marketing type. Options: Any, For Sale, For Rent.
Limit Maximum number of results to return. Defaults to 50.
Offset Offset for result pagination. Defaults to 0.

Output

The output JSON contains an array of estate records under the data field, each record including the requested fields as specified in "Fields to Return". Additionally, the output includes:

  • success: Boolean indicating if the operation succeeded.
  • operation: The performed operation name ("findMany").
  • total: (optional) Total count of matching records if provided by the API.
  • message: (optional) Informational message from the API response.

Example output structure:

{
  "success": true,
  "operation": "findMany",
  "data": [
    {
      "Id": "12345",
      "objektnr_extern": "EXT-001",
      "objekttitel": "Cozy Apartment",
      "vermarktungsart": "miete",
      "objektart": "wohnung",
      "kaufpreis": 0,
      "kaltmiete": 1200,
      ...
    },
    ...
  ],
  "total": 150
}

No binary data output is produced by this operation.

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 https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect field names or unsupported filter values may lead to API errors.
    • Exceeding API rate limits or network connectivity problems can cause request failures.
    • Providing invalid operators or empty filter values might result in unexpected behavior.

  • Error messages:

    • "OnOffice API action error: <message>": Indicates the API returned an error for the requested action. Check the message for details, verify parameters and credentials.
    • "OnOffice API error: <message>": General API error, possibly due to malformed requests or server issues.
    • Network or HTTP errors will propagate as standard errors; ensure network access and correct endpoint URL.

  • Resolution tips:

    • Verify API credentials are correctly set up.
    • Double-check filter fields, operators, and values for correctness.
    • Use smaller limits or adjust offsets to handle large datasets.
    • Enable "Continue On Fail" option in the node to handle partial failures gracefully.

Links and References

Discussion