OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate - Update operation, it updates an existing estate record in the OnOffice system by sending modified data fields.

Common scenarios where this node is useful include:

  • Automating updates to property listings when details change (e.g., price, description, status).
  • Synchronizing estate data from other systems or forms into OnOffice.
  • Bulk updating multiple estates programmatically within a workflow.

Example: You have a CRM that tracks property information and want to update the corresponding estate records in OnOffice whenever changes occur, ensuring data consistency across platforms.

Properties

Name Meaning
ID The unique identifier of the estate record to update. This is required to specify which estate to modify.
Data A JSON object containing the fields and values to update on the estate record. Must be valid JSON representing the new data state.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the update operation on an estate, the output JSON structure includes:

  • success: Boolean indicating if the update was successful.
  • resourceType: The resource type, here always "estate".
  • operation: The operation performed, here "update".
  • data: The response data returned from the OnOffice API after the update.
  • message: A message from the API about the update result.

No binary data is produced by this node.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "update",
  "data": { /* updated estate data from API */ },
  "message": "Update successful"
}

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of these credentials in n8n is necessary before use.

Troubleshooting

  • Invalid JSON in Data field: If the Data property contains malformed JSON, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Missing or incorrect ID: The ID property is mandatory for update operations. Omitting it or providing an invalid ID will cause errors.
  • API errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API credentials and request parameters.
  • Network issues: Network failures result in "Network error" messages. Verify internet connectivity and API endpoint accessibility.
  • Unsupported resource or operation: If the resource or operation is not supported, the node throws descriptive errors indicating the unsupported action.

To resolve errors, verify input parameters, ensure valid JSON formatting, confirm API credentials, and check network connectivity.

Links and References

Discussion