Actions15
Overview
This node interacts with the OnOffice API to manage and retrieve real estate-related data. Specifically, for the Relation resource with the Get Many operation, it fetches multiple relation records that link estates and addresses (contacts). This is useful when you want to list or filter relationships such as owners, tenants, interested parties, or contacts associated with properties.
Common scenarios include:
- Retrieving all relations of a certain type (e.g., all tenants linked to estates).
- Filtering relations by specific estate or address IDs.
- Paginating through large sets of relation data using limit and offset.
- Applying advanced filters to refine the results based on custom criteria.
Practical example:
- You want to get a list of all "Owner" relations for a particular estate to send them notifications.
- Fetching all relations linked to a specific address/contact to understand their involvement with various estates.
Properties
| Name | Meaning |
|---|---|
| Fields | Select which fields to return for each relation. Options: ID, Type, Estate ID, Address ID. |
| Filter by Type | Filter relations by type. Options: Any (no filter), Owner, Tenant, Interested, Contact. |
| Filter by Estate ID | Filter relations linked to a specific estate by its ID. |
| Filter by Address ID | Filter relations linked to a specific address/contact by its ID. |
| Advanced Filter | Provide advanced filter criteria in JSON or query format to further refine results. |
| Limit | Maximum number of relation records to return (pagination). Default is 50. |
| Offset | Number of records to skip before starting to collect the result set (pagination). Default 0. |
Output
The output is a JSON array where each item represents a relation record matching the query. The structure depends on the selected fields but generally includes:
id: Unique identifier of the relation.type: Type of the relation (owner, tenant, interested, contact).estateid: ID of the related estate.addressid: ID of the related address/contact.
Additionally, the output contains metadata such as success status, total count (if available), and any messages from the API.
If an error occurs, the output will contain error details including the message and raw API response if available.
Dependencies
- Requires an API token credential for authenticating with the OnOffice API.
- The node makes 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, requiring both an API token and secret.
Troubleshooting
- Invalid JSON in Filters or Data: If advanced filters or data inputs are malformed JSON, the node throws an error indicating invalid JSON. Ensure JSON syntax correctness.
- API Request Failures: Network issues or invalid credentials can cause API request failures. Error messages will indicate "API Request Failed" with details.
- Unsupported Resource or Operation: If an unsupported resource or operation is selected, the node throws an error specifying the unsupported action.
- Empty Results: If filters are too restrictive or IDs do not exist, the node may return empty arrays. Verify filter values and IDs.
- Rate Limits or Authentication Errors: If the API token or secret is incorrect or expired, authentication errors occur. Check and update credentials accordingly.
Links and References
- OnOffice API Documentation (general reference for API capabilities)
- n8n documentation on HTTP Request Node for understanding underlying HTTP calls
- HMAC Signature concepts: HMAC Wikipedia