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.

Common scenarios for this node include automating the management of relationships between estates and contacts (addresses) in a real estate system. For example, you might use it to remove outdated or incorrect links between properties and their owners, tenants, or other related parties.

Practical example: Automatically deleting a relation when a tenant moves out or a contact is no longer associated with a property.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete. This is required for the Delete operation on the Relation resource.

Output

The node outputs JSON data structured as follows:

  • 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 from the OnOffice API describing the result of the deletion.

Example output JSON:

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

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs configuration of these credentials within n8n (an API key credential and secret).
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/v1.

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 and exists in the OnOffice system.
  • Authentication Errors: Missing or invalid API token/secret will cause authentication failures. Verify that the credentials are correctly configured in n8n.
  • Network Issues: Network errors during the HTTP request will throw exceptions. Check your internet connection and API availability.
  • API Error Messages: The node surfaces API error messages directly. Common messages may relate to permission issues or invalid requests. Review the message for guidance.
  • JSON Parsing Errors: Although not applicable for Delete operation input, other operations require valid JSON inputs. Invalid JSON will cause errors.

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

Links and References

Discussion