OnOffice

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, agent logs, relations, tasks, and IDs from relations. Specifically, for the Agent Log resource with the Get operation, it retrieves a single agent log record by its ID.

Common scenarios where this node is useful include:

• Fetching detailed information about a specific agent log entry in a real estate management system.
• Integrating agent log data into workflows for reporting or auditing purposes.
• Automating retrieval of agent activity logs for further processing or notifications.

Example: You want to retrieve an agent log entry with a known ID to display its details in a dashboard or to trigger follow-up actions based on the log content.

Properties

Output

The node outputs JSON data structured as follows:

• If Include Debug Info is false (default), the output JSON contains:

  {
    "success": true,
    "resourceType": "agentslog",
    "operation": "get",
    "data": []
  }
  

  Here, "data" will contain the retrieved agent log record(s) from the API response.

• If Include Debug Info is true, the output JSON includes additional fields for debugging:

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

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 at https://api.onoffice.de/api/latest/api.php (or a legacy URL for some resources).
• The node internally generates HMAC signatures for secure API requests.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Providing an incorrect or non-existent ID will result in an API error indicating the record was not found.
  • Network connectivity problems can cause request timeouts or failures.

• Error messages:

  • "OnOffice API error: <message>" indicates the API returned an error status. Check the message for details such as invalid parameters or permission issues.
  • If the node throws errors related to HMAC signature generation, verify that the API token and secret are correctly configured.

• Resolution tips:

  • Ensure the ID parameter is correct and corresponds to an existing agent log record.
  • Verify API credentials and permissions.
  • Enable Include Debug Info to get detailed request and response data for troubleshooting.

Links and References

• OnOffice API Documentation (official API docs)
• n8n documentation on HTTP Request node for understanding HTTP interactions (conceptual reference)