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 related to real estate management, CRM updates, or reporting.

Practical examples include:

  • Fetching an estate's details before updating or processing it.
  • Retrieving key estate fields like title and external number for display in dashboards.
  • Integrating estate data into other systems by pulling specific fields on demand.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve. This is required.
Fields Comma-separated list of fields to return from the estate record. Defaults to Id,objekttitel,objektnr_extern. Example: Id,objekttitel

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 records returned by the API. For the "get" operation, this typically contains one estate object with the requested fields.
  • total: (Optional) Total count of records, present if metadata is returned by the API.
  • 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"
    }
  ],
  "total": 1
}

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 record: If the provided estate ID does not exist, the API may return an error or empty data. Verify the ID is correct.
  • Malformed Fields parameter: The Fields input must be a comma-separated string of valid field names. Invalid fields may cause API errors or incomplete data.
  • Invalid JSON in filter or data fields: Although not applicable for the "get" operation, other operations require valid JSON inputs; invalid JSON will throw errors.
  • API authentication errors: Ensure that the API token and secret are correctly configured and have sufficient permissions.
  • Network issues: Errors like timeouts or unreachable API endpoints will result in network error messages.
  • Error messages: The node surfaces API error messages prefixed with "OnOffice API error:" and network issues with "Network error:". Review these messages for troubleshooting.

Links and References

Discussion