OnOffice

Consume OnOffice API
Join our community

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 or location details associated with real estate properties.

Practical examples include:

  • Fetching the full contact details of an address linked to a property.
  • Retrieving specific fields like name, email, or phone number for use in workflows such as sending notifications or updating CRM systems.

Properties

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

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "get".
  • data: An array of records returned by the API, each containing the requested fields of the address.
  • total (optional): Total count of records if available (mainly relevant for multi-record queries).
  • 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"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API.
  • The node uses HMAC signature authentication for secure API requests.
  • Network access to https://api.onoffice.de/api/latest/api.php is necessary.

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 syntax errors. Incorrect formatting can cause unexpected results.
  • API authentication errors: Ensure the API token and secret are correctly configured; otherwise, authentication will fail.
  • Filter JSON parsing errors: Although not applicable for the "Get" operation, other operations that accept JSON filters require valid JSON syntax.
  • Network issues: Connectivity problems will result in network errors; check your internet connection and firewall settings.

Common error messages:

  • "OnOffice API error: <message>" indicates an issue reported by the API, often due to invalid parameters or authentication.
  • "Network error: <message>" indicates connectivity problems.

Links and References

Discussion