OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the "Estate" resource with the "Get Many" operation, it retrieves multiple estate records from the OnOffice system based on specified criteria. This is useful in scenarios where you want to fetch a list of estates with selected fields and optional filtering, pagination (limit and offset).

Practical examples include:

  • Fetching a list of available properties with key details like ID, title, and external number.
  • Retrieving 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 filter criteria to narrow down the query results.
- Limit Maximum number of estate records to return (default 50).
- Offset Number of records to skip before starting to return results (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 available (from metadata).

Example output structure:

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Apartment",
      "objektnr_extern": "EXT456"
      // other requested fields...
    },
    ...
  ],
  "total": 150
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary for authentication.

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.
  • Invalid JSON in Data: For create or update operations (not applicable here but relevant for the resource), invalid JSON in the data field will cause errors.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message prefixed with "OnOffice API error". Check the API credentials and request parameters.
  • Network Issues: Network connectivity problems result in errors prefixed with "Network error".
  • Unsupported Resource or Operation: Attempting unsupported combinations will throw errors indicating the resource or operation is not supported.
  • Pagination Limits: Setting very high limits may cause performance issues or API rejections; use reasonable values.

Links and References

Discussion