OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage relations between real estate estates and addresses (contacts). Specifically, the "Create Relation" operation allows users to establish a new relationship linking an estate with an address, defining the type of relation such as owner, tenant, interested party, or contact.

Common scenarios include:

  • Associating a property (estate) with its owner or tenant.
  • Linking contacts who are interested parties in a particular estate.
  • Managing contact roles related to real estate assets within a CRM or property management workflow.

Practical example:

  • Automatically create a "tenant" relation when a new rental agreement is signed, linking the tenant's contact information to the specific estate in the system.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID The unique identifier of the estate to which the relation applies (required)
Address ID The unique identifier of the address/contact involved in the relation (required)

Output

The output JSON contains the result of the create operation with the following structure:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "create".
  • data: The data returned by the API about the newly created relation.
  • message: A status message from the API confirming the action.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    "id": "12345",
    "type": "tenant",
    "estateid": "estate_6789",
    "addressid": "address_9876"
  },
  "message": "Relation created successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs valid API credentials including an API token and secret for authentication.
  • The node uses HMAC signature generation for secure API requests.
  • Network access to https://api.onoffice.de/api/stable/api.php is required.

Troubleshooting

  • Invalid JSON in input data: If the input fields expecting JSON (like filters or data) are malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • API errors: Errors returned by the OnOffice API will be surfaced with their messages. Common causes include invalid IDs, missing required fields, or permission issues.
  • Network errors: Connectivity problems or incorrect API endpoint configuration can cause network errors.
  • Unsupported operations or resources: Attempting to use unsupported combinations of resource and operation will result in explicit errors.
  • To handle failures gracefully, enable "Continue on Fail" to allow processing of subsequent items even if one fails.

Links and References

Discussion