OnOffice icon

OnOffice

Consume OnOffice API

Actions15

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 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 database.

Common scenarios include:

  • Displaying detailed property information in a workflow.
  • Synchronizing property data with other systems.
  • Triggering actions based on specific estate attributes.

Example: You want to retrieve the details of a property with ID "12345" including its title, purchase price, living space, and number of rooms to display or process further.

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 estate records matching the query (usually one record for "get" operation).
  • total: (optional) Total count of records if available.
  • status: Status information returned by the API.
  • message: Informational message from the API response (for create/update/delete operations).

Additionally, the node outputs debug information including the raw API response and the request sent.

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.

Troubleshooting

  • Invalid JSON Data: When creating or updating estates, the data property must be valid JSON. Invalid JSON will cause an error.
  • API Request Failed: Network issues or invalid credentials can cause the API request to fail. Check your API token and secret.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error.
  • API Action Error: If the API returns an error code, the node surfaces the error message. Verify the parameters and permissions.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.

Links and References

Discussion