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 or processing information about a particular estate in workflows.

Practical examples:

  • Fetching an estate's details to display on a dashboard.
  • Retrieving property information before updating or linking related records.
  • Using estate data to trigger further automation based on property attributes.

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 (e.g., Id,objekttitel,objektnr_extern). Controls which estate properties are included in the response.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource type, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array containing the retrieved estate record(s) with the requested fields.
  • total (optional): Total number of records returned (mainly relevant for multi-record queries).
  • message (optional): Status message from the API.

Example output 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 valid credentials for the OnOffice API, specifically an API token and secret.
  • The node uses HMAC signature authentication for API requests.
  • Network access to https://api.onoffice.de/api/v1 is necessary.

Troubleshooting

  • Invalid ID or missing ID: The node requires a valid estate ID; omitting or providing an incorrect ID will cause errors.
  • Malformed Fields parameter: The Fields input must be a comma-separated string of valid field names. Incorrect formatting may lead to incomplete or failed responses.
  • API errors: If the OnOffice API returns an error, the node surfaces the message. Common causes include invalid credentials, insufficient permissions, or network issues.
  • Filter JSON parsing errors: Although not applicable for the "Get" operation, other operations that accept JSON filters require valid JSON syntax; otherwise, an error is thrown.
  • Network issues: Connectivity problems result in network error messages; verify internet access and API endpoint availability.

Links and References

Discussion