OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address - Get operation, it retrieves detailed information about a single address record by its unique ID. This is useful when you need to fetch contact details or other address-specific data stored in the OnOffice system.

Common scenarios:

  • Fetching contact information for a client or property owner.
  • Retrieving address details to populate forms or databases.
  • Integrating address data into workflows for notifications or reporting.

Example:
You want to get the email and name of a contact associated with a property. You provide the address ID and specify which fields to return (e.g., id,name,email), and the node returns the requested data from OnOffice.

Properties

Name Meaning
ID The unique identifier of the address record to retrieve.
Fields Comma-separated list of fields to return from the address record (e.g., id,name,email).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "get".
  • data: An array of records containing the requested fields for the address.
  • total (optional): Total number of records returned (usually 1 for a single get).
  • message (optional): Status message from the API.

If the operation fails, the output will contain:

  • success: false
  • error: Error message describing what went wrong.
  • resourceType and operation for context.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/v1.
  • Requires proper configuration of the API token and secret in the node credentials.
  • The node internally generates HMAC signatures for request authentication.

Troubleshooting

  • Invalid ID or missing record: If the provided ID does not exist, the API may return an error or empty data. Verify the ID is correct.
  • Malformed fields parameter: The fields input must be a comma-separated string without invalid characters. Incorrect formatting might cause unexpected results.
  • Authentication errors: Ensure the API token and secret are correctly configured; otherwise, the API will reject requests.
  • Filter JSON parsing errors: Although not applicable for the "Get" operation, other operations that accept JSON filters require valid JSON syntax.
  • Network issues: Network failures or API downtime will result in network error messages.
  • Error messages from API: The node surfaces API error messages, e.g., "OnOffice API error: ". Check the message for clues on fixing the issue.

Links and References

Discussion