onOffice

Interact with onOffice API

Overview

This node interacts with the onOffice API to manage real estate data. Specifically, for the Estate - Delete operation, it deletes an existing estate record identified by its unique Estate ID. This is useful in scenarios where outdated or incorrect estate entries need to be removed from the system to maintain data accuracy.

Practical examples include:

  • Removing a sold or withdrawn property listing.
  • Cleaning up test or duplicate estate records.
  • Automating estate lifecycle management by deleting estates that no longer meet certain criteria.

Properties

Name Meaning
Estate ID The unique identifier of the estate to delete. This is required to specify which estate record should be removed.

Output

The output JSON contains the response from the onOffice API after attempting to delete the specified estate. Typically, this will include confirmation of deletion or any error messages returned by the API.

Example structure (simplified):

{
  "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:delete",
  "resourceid": "estate-id",
  "resourcetype": "estate",
  "parameters": {},
  "result": "success" // or error details if failed
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the onOffice API.
  • Needs an API authentication credential configured in n8n to authorize requests.
  • The node uses a POST request to the /api.php endpoint of the onOffice API with specific action identifiers.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Estate ID will cause the API to return an error.
    • Missing or incorrect API credentials will result in authentication failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages and resolutions:

    • "Estate not found": Verify the Estate ID is correct and exists in the onOffice system.
    • "Authentication failed": Check that the API key or token is valid and properly configured.
    • Timeout or network errors: Ensure stable internet connection and that the onOffice API endpoint is reachable.

Links and References

Discussion