OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, for the "Estate" resource and the "Get Many" operation, it retrieves multiple estate records from the OnOffice system based on specified criteria. This is useful when you want to fetch a list of estates with selected fields, optionally filtered and paginated.

Practical examples include:

  • Retrieving a list of available properties with key details like title and external number.
  • Fetching estates that match certain filter criteria (e.g., location, price range).
  • Paginating through large sets of estate data by specifying limits and offsets.

Properties

Name Meaning
Fields Comma-separated list of estate fields to return. Example: Id,objekttitel,objektnr_extern.
Additional Fields Collection of optional parameters:
- Filter: JSON object defining query filters.
- Limit: Maximum number of results to return (default 50).
- Offset: Number of results to skip before starting to collect the result set (default 0).

Output

The output is a JSON array where each item contains:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "getMany".
  • data: An array of estate records matching the query, each containing the requested fields.
  • total (optional): Total count of matching records if provided by the API.
  • message or rawResponse (in some cases): Additional information or raw API response.

No binary data is returned by this operation.

Example output snippet:

[
  {
    "success": true,
    "resourceType": "estate",
    "operation": "getMany",
    "data": [
      {
        "Id": "123",
        "objekttitel": "Beautiful Apartment",
        "objektnr_extern": "APT-456"
      },
      {
        "Id": "124",
        "objekttitel": "Cozy House",
        "objektnr_extern": "HSE-789"
      }
    ],
    "total": 2
  }
]

Dependencies

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

Troubleshooting

  • Invalid JSON in Filter: If the filter field contains invalid JSON, the node throws an error stating "Filter must be a valid JSON". Ensure the filter input is correctly formatted JSON.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message prefixed with "OnOffice API error:". Check the API credentials and the correctness of parameters.
  • Network Issues: Network errors are reported as "Network error: ...". Verify network connectivity and API endpoint accessibility.
  • Unsupported Resource or Operation: If an unsupported resource or operation is selected, the node throws an error indicating the unsupported combination.
  • Empty or Incorrect Fields: Specifying fields that do not exist may lead to incomplete data or API errors. Use valid field names as per OnOffice API documentation.

Links and References

Discussion