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 you have a contact no longer related to a property (e.g., a tenant moved out), you can use this node to delete that relation from your 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": "Relation deleted successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs valid API credentials consisting of an API token and secret for authentication.
  • The node uses HMAC signature generation for secure API requests.
  • Network access to https://api.onoffice.de/api/stable/api.php is required.

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 credentials will cause authentication failures. Ensure the API token and secret are correctly configured.
  • Network Issues: Connectivity problems to the OnOffice API endpoint will result in network errors.
  • API Error Messages: The node surfaces API error messages; these often indicate issues like invalid parameters or permission problems. Review the message for guidance.
  • JSON Parsing Errors: Although not directly relevant for delete, other operations require valid JSON input. Invalid JSON will throw errors.

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

Discussion