OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, the "Estate" resource with the "Get" operation allows users to retrieve detailed information about a single real estate record by its ID. This is useful in scenarios where you need to fetch specific property details for further processing, reporting, or integration with other systems.

Practical examples:

  • Fetching detailed information about a property before sending it in an email.
  • Retrieving estate data to display on a website or dashboard.
  • Using the estate details as input for another workflow step, such as updating a CRM or generating documents.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve. This is required for the "Get" operation.
Fields Comma-separated list of fields to return from the estate record. Example: Id,objekttitel,objektnr_extern. Defaults to these three fields if not specified.

Output

The output JSON contains the following structure:

  • 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 records returned by the API containing the requested estate fields.
  • total (optional): Total number of records matching the query (mainly relevant for multi-record queries).
  • message (optional): Status message from the API.

Example output JSON snippet:

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

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret credential 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.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Invalid JSON in Fields or Data: If the "Fields" or any JSON input parameters are malformed, the node will throw an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • Missing Required ID: The "ID" property is mandatory for the "Get" operation. Omitting it will cause an error.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message. Common causes include invalid credentials, incorrect IDs, or network issues.
  • Network Issues: Network errors during the HTTP request will be reported. Check connectivity and API endpoint availability.
  • Filter Parsing Errors: Although not applicable for the "Get" operation, filters used in other operations must be valid JSON; otherwise, an error is thrown.

To resolve errors, verify input parameters, ensure valid credentials, and confirm the API service status.

Links and References

Discussion