OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, relations, tasks, and agent logs. Specifically for the Address resource with the Delete operation, it deletes an address record identified by a given ID.

Common scenarios where this node is useful include automating the cleanup of outdated or incorrect address records in a real estate management system, or integrating address deletion into broader workflows that maintain data consistency across platforms.

For example, when a property listing is removed from a database, this node can be used to automatically delete the associated address record from OnOffice, ensuring no orphaned data remains.

Properties

Name Meaning
ID The unique identifier of the address record to delete. This is required for deletion.
Include Debug Info Boolean flag to include detailed debug information in the output, useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • On success (without debug info):

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

    This indicates the deletion was successful.

  • On success (with debug info 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 and request details for debugging purposes.

  • On failure (if continueOnFail is enabled):

    {
  "success": false,
  "error": "Error message describing what went wrong",
  "resourceType": "address",
  "operation": "delete"
}

The node does not output binary data.

Dependencies

  • Requires an API token credential and API secret credential for authenticating with the OnOffice API.
  • Uses the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php.
  • The node internally generates HMAC signatures for secure API requests.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing ID parameter will cause the API to reject the request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems may cause request failures.
    • API rate limits or server errors could lead to unexpected failures.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error; check the message for specifics.
    • If the node throws an error about missing credentials, ensure the API token and secret are correctly configured.
    • Enabling "Include Debug Info" helps diagnose issues by showing raw request and response data.

  • Resolution tips:

    • Verify the ID corresponds to an existing address record.
    • Confirm API credentials are valid and have necessary permissions.
    • Use debug info to inspect request/response details.
    • Check network access and firewall settings if requests fail to reach the API.

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.

Discussion