OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Relation - Get operation, it retrieves detailed information about a specific relation entity by its ID. Relations typically represent connections between estates and addresses (contacts), such as ownership or tenancy.

Common scenarios where this node is beneficial include:

  • Fetching details of a particular relation to understand the connection between a property and a contact.
  • Automating workflows that require validation or processing of relationship data in real estate management systems.
  • Integrating OnOffice relation data into other systems like CRMs or reporting tools.

Example use case: You want to retrieve the owner or tenant information linked to a specific estate by querying the relation record using its unique Relation ID.

Properties

Name Meaning
Relation ID The unique identifier of the relation record to retrieve. This is required.
Fields The fields to return for the relation. Options include: ID, Type, Estate ID, Address ID. By default, all these fields are returned.

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "relation".
  • operation: The operation performed, here "get".
  • data: An array of relation records matching the query. For the "get" operation by ID, this will typically contain one relation object with the requested fields.
  • total (optional): Total number of records found (mainly relevant for "getMany").
  • message (optional): Informational message from the API response.
  • rawResponse: The full raw API response for debugging purposes.

Each relation record includes the fields requested, such as:

  • id: Relation's unique ID.
  • type: Type of relation (e.g., owner, tenant).
  • estateid: ID of the related estate.
  • addressid: ID of the related address/contact.

No binary data is output by this node.

Dependencies

  • Requires an API token credential and API secret for authenticating with the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the OnOffice API credentials in n8n is necessary.

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is malformed, the API may return an error or empty data. Verify the ID correctness.
  • Authentication Errors: Missing or incorrect API token/secret will cause authentication failures. Ensure credentials are correctly set up.
  • API Request Failed: Network issues or API downtime can cause request failures. Check connectivity and API status.
  • Data Parsing Errors: If the node expects JSON input for other operations but receives invalid JSON, it throws errors. For "get" operation, this is not applicable.
  • Unknown API Errors: The node surfaces API error messages when available; otherwise, generic errors are shown. Review the error message for clues.

Using the node's "Continue on Fail" option can help handle intermittent errors gracefully.

Links and References

Discussion