Overview

This node reads appointment data from the onOffice system. It allows users to retrieve specific appointment details by providing a Resource ID or by specifying various filtering parameters such as date ranges, user IDs, and status flags. This is useful for scenarios where you need to fetch appointment information for scheduling, reporting, or integration with other systems.

Use Case Examples

1. Fetch a specific appointment by its Resource ID to display detailed information.
2. Retrieve all appointments within a certain date range for selected users to generate a schedule report.
3. Get appointments including cancelled ones and show their confirmation status for administrative review.

Properties

Output

JSON

• appointmentId - Unique identifier of the appointment.
• dateStart - Start date and time of the appointment.
• dateEnd - End date and time of the appointment.
• confirmationStatus - Overall confirmation status of the appointment, if requested.
• status - Current status of the appointment, e.g., cancelled or active.
• userId - Identifier of the user associated with the appointment.
• details - Additional details or metadata related to the appointment.

Dependencies

• An API key credential for onOffice API authentication

Troubleshooting

• Ensure the Resource ID is correct and exists in the system to avoid 'not found' errors.
• If using JSON Parameters, verify the JSON syntax is valid to prevent parsing errors.
• Check date formats in additional fields to match expected ISO date-time format to avoid query failures.
• If no appointments are returned, verify that the filter criteria (dates, users, status flags) are correctly set and that data exists for those parameters.

Links

• onOffice API Documentation - Official API documentation for onOffice, useful for understanding available endpoints and parameters.