OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate data and related resources. Specifically, for the Estate - Get operation, it retrieves detailed information about a single real estate record by its unique ID. This is useful when you need to fetch specific property details such as title, type, price, location, and other attributes from your OnOffice account.

Common scenarios include:

  • Fetching detailed information about a property to display in a dashboard or report.
  • Retrieving property data to synchronize with another system.
  • Using property details as input for further automation workflows, e.g., sending notifications or generating documents.

Example: You want to get the details of a property with ID "12345" including its title, purchase price, number of rooms, and city.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve (required).
Fields Select which fields of the estate to return. Options include:
- ID
- External Object Number
- Title
- Type of Marketing
- Property Type
- Purchase Price
- Cold Rent
- Living Space
- Number of Rooms
- Postal Code
- City
- Street
- House Number
- Description
- Creation Date
- Last Change Date
- Status

The default selected fields are: ID, External Object Number, Title, Type of Marketing, Property Type, Purchase Price, Cold Rent, Living Space, and Number of Rooms.

Output

The output JSON contains the following structure:

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

Example output snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": [
    {
      "Id": "12345",
      "objektnr_extern": "EXT-001",
      "objekttitel": "Modern Apartment Downtown",
      "vermarktungsart": "kauf",
      "objektart": "wohnung",
      "kaufpreis": 250000,
      "kaltmiete": null,
      "wohnflaeche": 80,
      "anzahl_zimmer": 3,
      "plz": "50667",
      "ort": "Köln",
      "strasse": "Hauptstraße",
      "hausnummer": "12",
      "objektbeschreibung": "Schöne, moderne Wohnung im Zentrum.",
      "erstellungsdatum": "2023-01-01T00:00:00Z",
      "aenderungsdatum": "2023-06-01T00:00:00Z",
      "status": "active"
    }
  ]
}

No binary data is output 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.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Invalid JSON Data: If the "Data" property (for create/update operations) is not valid JSON, the node throws an error. Ensure JSON syntax correctness.
  • API Request Failed: Network issues, invalid credentials, or incorrect parameters can cause API failures. Check the error message for details.
  • Unsupported Resource or Operation: Selecting a resource or operation not supported by the node results in an error.
  • Missing Required Parameters: The "ID" field is required for the "get" operation; omitting it causes errors.
  • Permission Issues: Ensure the API token has sufficient permissions to read estate data.

To resolve errors:

  • Verify API credentials and permissions.
  • Confirm that the ID exists and is correct.
  • Validate JSON inputs where applicable.
  • Use the debug output included in the node's response to inspect raw API responses.

Links and References

Discussion