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 create, find (single or multiple), and delete relations that define how an address is connected to an estate, such as ownership, tenancy, or contact roles.

This node is beneficial in real estate management workflows where automating the association of properties (estates) with various stakeholders (addresses) is required. For example, a user can automatically link a tenant's address to a rental property or update the owner information for an estate.

Practical examples:

  • Creating a new relation to mark an address as the owner of a specific estate.
  • Finding all contacts related to a particular estate.
  • Deleting outdated or incorrect relations between estates and addresses.

Properties

Name Meaning
Estate ID The unique identifier of the estate involved in the relation.
Address ID The unique identifier of the address involved in the relation.
Relation Type The type of relationship between the estate and the address. Options: Owner, Tenant, Interested Party, Contact.

Output

The node outputs JSON data describing the result of the operation performed:

  • For create operations, it returns success status, operation name, created data details, and a message from the API.
  • For find and findMany operations, it returns success status, operation name, an array of matching relation records, and optionally total count metadata.
  • For delete operations, it returns success status, operation name, and a confirmation message.

The output JSON structure includes fields like success (boolean), operation (string), data (array or object depending on operation), total (number, for findMany), and message (string).

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Relies on helper functions for generating request IDs and HMAC signatures to securely authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing incorrect or non-existent Estate ID or Address ID may result in empty results or errors.
    • Using unsupported relation types or malformed parameters can trigger API errors.

  • Error messages:

    • "OnOffice API action error: <message>": Indicates the API returned an error for the requested action. Check parameter correctness and API limits.
    • "OnOffice API error: <message>": General API communication error; verify network connectivity and API availability.
    • Node operation errors include the item index to help identify which input caused the failure.

  • Resolution tips:

    • Ensure valid and active API credentials are configured.
    • Double-check IDs and relation types before running the node.
    • Use the "Continue On Fail" option to handle errors gracefully during batch processing.

Links and References

Discussion