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.
  • Generating reports or dashboards that require bulk estate data.
  • Filtering estates by specific criteria (e.g., location, status) and retrieving only relevant fields for efficiency.

For example, a user can configure the node to get up to 50 estates starting from the 10th record, returning only the estate ID, title, and external number fields.

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. Must be valid JSON.
- 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 operation succeeded.
  • 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 on the server (if provided by API metadata).

Example output structure (simplified):

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Villa",
      "objektnr_extern": "EXT456"
    },
    {
      "Id": "124",
      "objekttitel": "Modern Apartment",
      "objektnr_extern": "EXT457"
    }
  ],
  "total": 200
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node uses HMAC signature generation for request authentication.
  • Network access to https://api.onoffice.de/api/v1 is required.
  • Proper configuration of the API credentials within n8n is necessary.

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: Although not applicable for "Get Many", other operations require valid JSON in the data field; invalid JSON 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: If an unsupported resource or operation is selected, the node throws an error indicating the unsupported action.

To resolve these issues:

  • Validate JSON inputs carefully.
  • Verify API credentials and permissions.
  • Confirm network connectivity to the API endpoint.
  • Use supported resources and operations as per the node's capabilities.

Links and References

Discussion