OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on the "Relation" resource in this context. The "Get Many" operation retrieves multiple relation records from the OnOffice system based on specified criteria.

Typical use cases include:

  • Fetching a list of relations (e.g., owners, tenants, contacts) associated with estates and addresses.
  • Filtering relations by custom criteria to analyze or process subsets of data.
  • Paginating through large sets of relation records using limit and offset parameters.

For example, a user might retrieve all tenant relations linked to certain estates or fetch a paginated list of contacts for reporting purposes.

Properties

Name Meaning
Fields Comma-separated list of fields to return for each relation record. Example: id,type,estateid,addressid
Additional Fields Collection of optional parameters:
- Filter JSON object defining filter criteria to narrow down the query results.
- Limit Maximum number of relation records to return (default is 50).
- Offset Number of records to skip before starting to collect the result set (default is 0).

Output

The output is a JSON array where each item represents the result of the API call for one input item. For the "Get Many" operation on the Relation resource, the structure includes:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "getMany".
  • data: An array of relation records matching the query. Each record contains the requested fields as specified in the "Fields" property.
  • total (optional): Total count of matching records available in the backend, useful for pagination.
  • message (optional): Status message from the API response.
  • rawResponse (optional): Full raw response data from the API for advanced use cases.

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 at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary for successful operation.

Troubleshooting

  • Invalid JSON in Filter: If the filter JSON is malformed, the node throws an error stating "Filter must be a valid JSON". Ensure the filter string is correctly formatted JSON.
  • API Authentication Errors: Errors related to invalid or missing API tokens will cause the node to fail. Verify that the API credentials are correctly configured and active.
  • Network Issues: Network errors during the HTTP request will be reported with messages like "Network error: ...". Check network connectivity and API availability.
  • Unsupported Operations or Resources: Attempting operations not supported for the Relation resource will result in errors specifying unsupported resource or operation.
  • Empty or Incorrect Fields: Specifying fields that do not exist may lead to incomplete or empty data arrays. Use valid field names as per OnOffice API documentation.

Using the "Continue On Fail" option allows the workflow to proceed even if some items cause errors, returning error details in the output.

Links and References

Discussion