OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate - Get operation, it retrieves detailed information about a single estate record by its unique ID. This is useful in scenarios where you need to fetch specific property details from your OnOffice database, such as when displaying property information in a dashboard or syncing estate data with other systems.

Practical examples:

  • Fetching an estate's details to display on a website.
  • Retrieving estate information before updating or processing it further.
  • Integrating estate data into CRM or ERP systems for enhanced workflows.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve.
Fields Comma-separated list of fields to return from the estate record (e.g., Id,objekttitel,objektnr_extern).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array of estate records matching the query. For the "Get" operation, this will typically contain one estate object with the requested fields.
  • total (optional): Total number of records found (mainly relevant for multi-record queries).
  • message (optional): Status message returned by the API.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": [
    {
      "Id": "12345",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT-6789"
      // ... other requested fields
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node expects these credentials to be configured in n8n prior to execution.
  • Network access to https://api.onoffice.de/api/latest/api.php is necessary.

Troubleshooting

  • Invalid JSON in Fields or Data: If the "Fields" parameter or any JSON input is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • Missing or Invalid ID: The "ID" property is required for the Get operation. Omitting it or providing an incorrect ID will cause the API to return an error.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message. Common causes include invalid credentials, insufficient permissions, or non-existent records.
  • Network Issues: Network connectivity problems result in network error messages. Verify internet access and API endpoint availability.
  • Filter Parsing Errors: Although not applicable for the "Get" operation, filters used in other operations must be valid JSON; otherwise, errors occur.

To resolve issues:

  • Double-check all input parameters for correctness.
  • Confirm API credentials are valid and have appropriate permissions.
  • Validate JSON syntax in all JSON-type inputs.
  • Check network connectivity and API status.

Links and References

Discussion