OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically handling resources such as estates, addresses, and relations. For the Relation resource with the Delete operation, it deletes a specified relation record by its ID. This is useful in scenarios where you need to remove associations between estates and contacts (addresses) in your real estate management workflows.

Practical example: If a tenant moves out or a contact is no longer related to a property, you can use this node to delete that relation from the OnOffice system automatically.

Properties

Name Meaning
Relation ID The unique identifier of the relation record to retrieve or delete.

Output

The node outputs JSON data containing the result of the delete operation. The structure includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A status message returned by the OnOffice API describing the outcome.

Example output JSON:

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

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs valid API credentials including an API token and secret configured in n8n.
  • Uses the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is incorrect, the API will return an error. Verify the ID before running the node.
  • API Authentication Errors: Ensure the API token and secret are correctly set up in the node credentials; otherwise, authentication will fail.
  • Network Issues: Network errors during the HTTP request will cause the node to throw an error. Check your internet connection and API availability.
  • Malformed Input: The Relation ID must be a non-empty string; missing or empty IDs will cause the node to error out.
  • API Error Messages: The node surfaces API error messages directly. Common messages include permission issues or invalid parameters. Review the message for guidance.

Links and References

Discussion