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 include:

  • Fetching an estate's details to display on a website or app.
  • Retrieving property information to update CRM records.
  • Using estate data as input for further automation steps like sending notifications or generating reports.

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 (e.g., Id,objekttitel,objektnr_extern). Allows customizing which estate attributes are fetched.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array containing the retrieved estate records matching the requested ID and fields.
  • total (optional): Total number of records returned (usually 1 for a get by ID).
  • 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, including an API token and secret.
  • The node uses HMAC signature authentication for secure 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. Incorrect field names might cause incomplete or failed responses.
  • Invalid JSON in other operations: Although not applicable to the "Get" operation, other operations require valid JSON inputs; errors will indicate malformed JSON.
  • API errors: Errors from the OnOffice API are surfaced with messages from the API response. Check API limits, credentials, and network connectivity.
  • Network issues: Network failures result in error messages indicating connection problems.

To resolve errors:

  • Double-check the estate ID and fields.
  • Ensure API credentials are correctly configured.
  • Validate network connectivity.
  • Review error messages for specific API feedback.

Links and References

Discussion