OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to retrieve multiple real estate ("Estate") records in bulk. It is designed to fetch a list of estates based on specified fields and optional filtering criteria, supporting pagination through limit and offset parameters.

Common scenarios where this node is beneficial include:

  • Synchronizing or importing multiple estate listings from OnOffice into another system.
  • Displaying filtered lists of estates in dashboards or reports.
  • Automating batch processing workflows that require estate data retrieval.

For example, you could use this node to get up to 50 estate records that match certain filter criteria (e.g., only estates in a specific city) and select which fields to return such as the estate ID, title, and external number.

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 for querying estates.
- 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 type, 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 (if provided by the API).

Example output structure:

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT456"
    },
    ...
  ],
  "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 uses HMAC signature authentication for requests.
  • Network access to https://api.onoffice.de/api/v1 is required.

Troubleshooting

  • Invalid JSON in Filter: If the filter field contains invalid JSON, the node throws an error "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 related), invalid JSON in the data field causes 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 "Network error" messages. Verify internet access and API endpoint availability.
  • Unsupported Resource or Operation: Using unsupported combinations will throw errors indicating the resource or operation is not supported.

Links and References

Discussion