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 in scenarios where you need to fetch contact details or other address-specific information stored in the OnOffice system.

Practical examples include:

  • Fetching a client's contact information before sending an email.
  • Retrieving address details to populate forms or CRM records.
  • Accessing specific fields of an address for reporting or automation workflows.

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, vorname, email).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "get".
  • data: Contains the retrieved address record(s) under data.records.
  • total (optional): Total number of records returned (mainly relevant for multiple records).
  • message (optional): Status message from the API.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "get",
  "data": [
    {
      "id": "123",
      "name": "Doe",
      "vorname": "John",
      "email": "john.doe@example.com"
      // other requested fields...
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Invalid JSON in Fields or Filter: If the fields or any filter JSON is malformed, the node throws an error indicating invalid JSON. Ensure these inputs are correctly formatted.
  • API Authentication Errors: If the API token or secret is incorrect or missing, the node will fail with an authentication error. Verify that the API credentials are properly configured.
  • Record Not Found: If the provided ID does not exist, the API may return an error or empty data. Confirm the ID is correct.
  • Network Issues: Network errors will be reported with messages like "Network error: ...". Check your internet connection and firewall settings.
  • Unsupported Resource or Operation: The node validates resource and operation combinations; unsupported ones will throw descriptive errors.

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

Links and References

Discussion