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 deletes a relation record identified by its Relation ID. Relations represent links between estates and addresses (contacts), such as owners, tenants, or interested parties.

Common scenarios:

  • Removing outdated or incorrect relations between properties and contacts.
  • Cleaning up data when a contact or estate is no longer related.
  • Automating data maintenance workflows in real estate management systems.

Practical example:
You have a property listed with several contacts linked as owners or tenants. When a tenant moves out, you can use this node to delete the corresponding relation entry automatically, ensuring your database stays accurate.


Properties

Name Meaning
Relation ID The unique identifier of the relation to delete. This specifies which relation record will be removed from the system.

Output

The node outputs a JSON object indicating the success or failure of the deletion request. The structure includes:

  • success: Boolean indicating if the deletion was successful.
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A confirmation message returned by the API upon successful deletion.
  • Additional debug information including raw API response and the request sent.

Example output JSON snippet:

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

If an error occurs, the output contains error details unless the node is configured to continue on failure.


Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • 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 will return an error. Verify the ID before attempting deletion.
  • Authentication errors: Ensure that the API token and secret are correctly set and valid. Authentication failures will prevent any API calls.
  • API Request Failed: Network issues or incorrect endpoint URLs can cause request failures. Check connectivity and endpoint correctness.
  • JSON Parsing Errors: Although not directly relevant for delete operation, other operations require valid JSON input; ensure JSON fields are well-formed.
  • Continue on Fail: If enabled, the node will output error details instead of stopping execution, useful for batch processing.

Links and References


This summary covers the static analysis of the OnOffice node's Relation Delete operation based on the provided source code and property definitions.

Discussion