OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The Delete Relation operation allows users to remove a specific relation by its ID. This is useful in scenarios where a connection between an estate and a contact (such as an owner, tenant, or interested party) needs to be removed from the system.

Practical example:
If a tenant moves out of a property, you can use this node to delete the tenant relation linking that person’s address record to the estate, ensuring your database reflects current occupancy accurately.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete. This is required for deletion.

Output

The node outputs a JSON object indicating the success or failure of the delete operation. The structure includes:

  • success: Boolean indicating if the deletion was successful (true).
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "delete".
  • message: A textual message returned by 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 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.
  • Proper configuration of the API credentials within n8n is necessary for successful communication.

Troubleshooting

  • Common issues:

    • Invalid or missing Relation ID will cause the API to reject the request.
    • Network connectivity problems may prevent reaching the OnOffice API.
    • Incorrect or expired API credentials will lead to authentication errors.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API responded with an error message. Check the Relation ID and credentials.
    • "Network error: <message>" suggests connectivity issues; verify internet access and API endpoint availability.
    • "Filter must be a valid JSON" (not applicable here but common in other operations) means JSON input fields are malformed.

  • Resolution tips:

    • Ensure the Relation ID is correct and exists in the OnOffice system.
    • Verify API credentials are up to date and correctly configured in n8n.
    • Confirm network access to the OnOffice API endpoint.
    • Use the node’s “Continue on Fail” option to handle errors gracefully in workflows.

Links and References

Discussion