OnOfficeInstall

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The "Get" operation for the "Relation" resource retrieves detailed information about a specific relation by its ID. This is useful when you want to fetch the connection details between an estate and a contact, such as the type of relation (owner, tenant, etc.) and linked entity IDs.

Practical examples:

• Retrieve the owner or tenant information linked to a particular estate.
• Fetch relation details to verify contacts associated with a property.
• Use in workflows that synchronize or audit real estate relations from OnOffice.

Properties

Output

The output JSON contains the following structure:

• success: Boolean indicating if the API call was successful.
• resourceType: The resource involved, here always "relation".
• operation: The operation performed, here "get".
• data: An array of relation records matching the query. Each record includes the requested fields such as relation ID, type, estate ID, and address ID.
• total (optional): Total count of records returned (mainly relevant for multi-record queries).

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "get",
  "data": [
    {
      "id": "123",
      "type": "owner",
      "estateid": "456",
      "addressid": "789"
    }
  ]
}

No binary data output is produced by this node.

Dependencies

• Requires an API token and secret credential for authenticating with 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 these credentials in n8n is necessary before use.

Troubleshooting

• Invalid JSON in Fields or Filter: If the "Fields" or any filter JSON is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
• API Authentication Errors: If the API token or secret is incorrect or missing, the node will fail with authentication errors. Verify credentials are set up properly.
• Resource or Operation Not Supported: Attempting unsupported operations or resources results in clear error messages specifying the unsupported action.
• Network Issues: Network failures during the HTTP request will throw network error messages. Check connectivity and API availability.
• OnOffice API Errors: If the API returns an error status, the node surfaces the message from the API response for easier debugging.

Links and References

• OnOffice API Documentation (official API docs)
• n8n Documentation (for general node usage and credential setup)