OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Relation resource and the Delete operation, it allows users to delete a relation record by its ID. Relations typically represent connections between estates and addresses (contacts), such as owners, tenants, or interested parties.

Common scenarios where this node is beneficial include:

  • Removing outdated or incorrect relations between properties and contacts.
  • Cleaning up data when a contact or estate is no longer relevant.
  • Automating maintenance of real estate databases by deleting specific relations programmatically.

Example: Deleting a tenant relation from a property after the lease ends.

Properties

Name Meaning
Relation ID The unique identifier of the relation record to delete. This is required to specify which relation to remove.

Output

The output JSON contains information about the success or failure of the delete operation. It includes:

  • success: Boolean indicating if the deletion was successful.
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A status message returned by the API confirming the deletion or providing additional info.

Example output JSON structure:

{
  "success": true,
  "resourceType": "relation",
  "operation": "delete",
  "message": "Relation deleted successfully"
}

If an error occurs, the output will contain error details instead.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the OnOffice API credentials in n8n is necessary.

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is malformed, the API may return an error. Verify the ID before attempting deletion.
  • Authentication Errors: Missing or invalid API credentials will cause request failures. Ensure the API token and secret are correctly configured.
  • API Request Failures: Network issues or API downtime can cause errors. Check connectivity and OnOffice service status.
  • JSON Parsing Errors: Although not directly applicable to delete, other operations require valid JSON input; ensure JSON fields are well-formed.
  • Error Messages: The node surfaces API error messages. Common messages include "API Request Failed" or "OnOffice API action error" with details. Use these to diagnose issues.

Links and References

Discussion