OnOffice

Consume OnOffice API
Join our community

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, the node supports operations including retrieving a single relation, retrieving multiple relations, creating a new relation, and deleting an existing relation.

The Delete operation for the Relation resource allows users to remove a specific relation by its ID. This is useful in scenarios where a relationship between an estate and an address (contact) is no longer valid or needs to be cleaned up from the system.

Practical example:
If you have a contact linked as a tenant to a property but the tenancy has ended, you can use this node's Relation Delete operation to remove that link from your OnOffice database.

Properties

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

Output

The output JSON contains information about the success of the delete operation along with metadata:

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

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 API authentication token and secret credential for the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Relation ID will cause the API to reject the request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Malformed JSON in other operations' input fields (not relevant for delete) can cause errors.
    • Network connectivity problems may prevent reaching the OnOffice API.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API responded with an error; check the message for details.
    • "Network error: <message>" indicates a failure to connect to the API endpoint.
    • "The operation "delete" is not supported for resource "relation"!" would indicate a misconfiguration but should not occur given the current implementation.
    • If the filter or data JSON is malformed (for other operations), the node throws an error specifying invalid JSON.

  • Resolution tips:

    • Verify the Relation ID is correct and exists in OnOffice.
    • Confirm API credentials are valid and have sufficient permissions.
    • Ensure network access to the OnOffice API endpoint.
    • Use the "Continue on Fail" option in n8n to handle errors gracefully if processing multiple items.

Links and References

Discussion