OnOffice Relation

Manage relationships between estates and addresses

Actions4

Overview

The OnOffice Relation node manages relationships between estates and addresses within the OnOffice system. It allows users to find, create, or delete relations that link estates to addresses with specific roles such as owner, tenant, interested party, or contact.

Common scenarios where this node is beneficial include:

  • Retrieving details of a specific relation by its ID.
  • Querying multiple relations with filters like relation type, estate ID, or address ID.
  • Creating new relations to define how an address relates to an estate.
  • Deleting existing relations by their ID.

Practical examples:

  • A real estate agent wants to fetch all tenants related to a particular estate.
  • Automatically creating a new owner relation when a property sale is finalized.
  • Removing outdated contact relations from the system.

Properties

Name Meaning
Relation ID The unique identifier of the relation to find or delete.
Fields to Return Select which fields to include in the output. Options: ID, Type, Estate ID, Address ID.

Output

The node outputs JSON data containing the results of the requested operation:

  • For Find and Find Many operations, the output includes an array of relation records with the selected fields.
  • For Create, it returns the created relation data along with a success message.
  • For Delete, it returns a success message confirming deletion.

Each output item contains at least:

  • success: Boolean indicating if the operation succeeded.
  • operation: The performed operation name (find, findMany, create, or delete).
  • data: The relation data (for find and create operations).
  • message: Informational messages for create and delete operations.
  • total: (For findMany) total number of matching records available.

No binary data is output by this node.

Dependencies

  • Requires an API token credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • The node internally generates HMAC signatures for request authentication.

Troubleshooting

  • API Authentication Errors: Ensure the provided API token and secret are correct and have sufficient permissions.
  • Relation Not Found: When using the Find or Delete operation, verify the Relation ID exists.
  • Invalid Filters: For Find Many, incorrect filter values may return empty results; double-check filter parameters.
  • Rate Limits or API Downtime: If requests fail unexpectedly, check OnOffice API status and respect any rate limits.
  • Error Messages: The node surfaces API error messages prefixed with "OnOffice API error" or "OnOffice API action error". Review these messages for clues on misconfiguration or invalid input.

If the node is set to continue on failure, errors will be returned in the output JSON with success: false and an error message.

Links and References

Discussion