OnOffice

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, relations, tasks, and others. Specifically for the Address resource with the Get Many operation, it retrieves multiple address records from the OnOffice system.

Common scenarios where this node is beneficial include:

• Fetching a list of addresses for real estate properties or contacts.
• Synchronizing address data from OnOffice into another system.
• Bulk processing or reporting on address information stored in OnOffice.

For example, a user might use this node to pull all addresses related to current listings to generate mailing labels or to analyze geographic distribution.

Properties

Output

The node outputs JSON data structured as follows:

• When Include Debug Info is disabled (default):

  {
    "success": true,
    "resourceType": "address",
    "operation": "getMany",
    "data": []
  }
  

  • success: Indicates if the API call was successful.
  • resourceType: The resource queried, here "address".
  • operation: The operation performed, here "getMany".
  • data: An array containing the retrieved address records (empty array shown as placeholder).

• When Include Debug Info is enabled:

  {
    "debug": true,
    "rawResponse": { /* full API response object */ },
    "requestSent": { /* full request payload sent to API */ },
    "url": "https://api.onoffice.de/api/latest/api.php"
  }
  

  This includes the raw API response, the exact request sent, and the URL used, which helps in debugging issues.

The node does not output binary data.

Dependencies

• Requires an API authentication token and secret credential for the OnOffice API.
• Uses the OnOffice API endpoint:
  • For the Address resource with Get Many operation: https://api.onoffice.de/api/latest/api.php
• No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

• Common Issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Network connectivity problems can prevent reaching the OnOffice API endpoint.
  • Request limits or API restrictions may result in partial or failed data retrieval.

• Error Messages:

  • "OnOffice API error: <message>" indicates an error returned by the API. The message usually describes the problem (e.g., invalid parameters, authentication failure).
  • If the node is set to continue on fail, errors are returned in the output JSON with success: false and an error message field.

• Resolutions:

  • Verify that the API token and secret are correctly configured.
  • Check network access to the OnOffice API URL.
  • Enable Include Debug Info to get detailed request and response data for diagnosing issues.

Links and References

• OnOffice API Documentation (official API docs for further details on endpoints and parameters)
• n8n HTTP Request Node documentation for understanding how HTTP calls are made within n8n workflows.