OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage relations between 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:

  • Real estate agencies linking properties (estates) to their owners or tenants.
  • Managing contacts related to specific estates for communication or record-keeping.
  • Tracking interested parties associated with a property.

Practical example:

  • A user wants to add a new tenant relation to a property by specifying the estate ID, the tenant's contact ID, and setting the relation type to "Tenant". This node will create that link in the OnOffice system.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID ID of the estate for which the relation is being created
Address ID ID of the address (contact) involved in the relation

Output

The output JSON contains information about the success of the operation and details of the created relation:

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

Example output JSON structure:

{
  "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 node.

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.
  • No additional external services are required beyond the OnOffice API.

Troubleshooting

  • Invalid JSON in input data: If the input fields like data or filters contain invalid JSON, the node throws an error. Ensure all JSON inputs are correctly formatted.
  • API authentication errors: Missing or incorrect API token/secret will cause authentication failures. Verify credentials are correctly configured.
  • Resource or operation not supported: Errors occur if unsupported resource-operation combinations are selected. Confirm you are using the correct resource ("relation") and operation ("create").
  • Network issues: Network errors during API calls will be reported. Check internet connectivity and API endpoint availability.
  • API error messages: The node surfaces API error messages when the OnOffice API returns an error status. Review the message for details on what went wrong.

Links and References

Discussion