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": "Relation deleted successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs an API token and secret for authentication, configured via node credentials.
  • Uses HMAC signature for request validation.
  • The base URL for API requests is https://api.onoffice.de/api/v1.

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 connectivity and API availability.
  • API Error Messages: The node surfaces API error messages; review these for details on issues like permission problems or invalid parameters.
  • JSON Parsing Errors: Although not directly relevant for delete, other operations require valid JSON input. Invalid JSON will cause errors.

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

Links and References

Discussion