OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage "Relation" resources, specifically allowing users to delete a relation by its ID. It is useful in scenarios where you need to programmatically remove associations between estates and contacts (addresses) within the OnOffice system. For example, if a tenant or owner relation is no longer valid, this node can automate the deletion process.

Properties

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

Output

The node outputs a JSON object indicating the success status of the delete operation. The output includes:

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

Example output JSON:

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

No binary data is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs configuration of these credentials in n8n before use.
  • Communicates with 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.
  • Authentication Errors: Missing or invalid API token/secret will cause authentication failures. Ensure credentials are correctly set up.
  • 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; review them to understand issues like permission problems or invalid parameters.
  • JSON Parsing Errors: Not applicable for delete operation since no JSON input is parsed here, but other operations may require valid JSON.

If the node is configured to continue on failure, it will output an error object instead of stopping execution.

Links and References

Discussion