OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically handling estates, addresses, and relations between them. The "Relation" resource with the "Delete" operation allows users to delete a specific relation record by its ID.

Common scenarios for this node include:

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

For example, if you have a relation representing a tenant linked to an estate and that tenant moves out, you can use this node to delete that relation automatically.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete. This is required.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating whether the operation was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A status message returned from the OnOffice API describing the result of the deletion.

Example output JSON:

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

The node does not output binary data.

Dependencies

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

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is malformed, the API will return an error. Ensure the ID is correct.
  • API Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API token and secret are correctly configured.
  • Network Issues: Network errors during the HTTP request will be reported. Check your internet connection and firewall settings.
  • API Error Messages: The node surfaces API error messages. For example, if the relation cannot be deleted due to dependencies, the API message will indicate the reason.
  • JSON Parsing Errors: Not applicable for delete operation since it only requires a string ID.

If the node is set to continue on failure, it will output an object with success: false and an error message instead of stopping execution.

Links and References

This summary focuses exclusively on the "Relation" resource with the "Delete" operation as requested.

Discussion