API Change Log - 7 Oct - 2025

Reports-Core V2

API Endpoint: {api_url}/v1/photo_management/bulk_operations/files
Scenario: This API retrieves and bulk edits metadata for up to 10 files in the guest/patient gallery, ensuring atomic updates.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API retrieves and bulk edits metadata for a maximum of 10 guest/patient gallery files, with all-or-nothing execution.

API Endpoint: {api_url} /v1/reports/employee_summary
Scenario: This API retrieves the employee summary report with enriched metrics, including detailed service, product, visit, hour, and demographic insights.
API method: POST
Earlier behavior: This API fetched the employee summary report with only basic metrics and no detailed breakdowns.
New behavior: This API fetches the employee summary report with expanded metrics, detailed breakdowns, and additional insights.

API Endpoint: {api_url}/v1/giftcards/templates?center_id={center_id}&giftcardtype={giftcardtype}&serviceOnly={serviceOnly}&fromOnline={fromOnline}&member_price={member_price}
Scenario: This API retrieves gift card amount templates based on gift card type, center preferences, and member pricing options.
API method: GET
Earlier behavior: This API returned templates without strict validation on the giftcardtype parameter.
New behavior: This API retrieves gift card amount templates and enforces validation on the giftcardtype parameter, permitting only values 0, 1, 2, or 3. Invalid values trigger an HTTP 400 Bad Request with an error code.

API Endpoint: {api_url}/ v1/reports/employee/metrics/flat_file
Scenario: The API fetches the employee metrics report, and with the update, the results can be filtered by service categories.
API method: POST
Earlier behavior: This API fetched the employee metrics report but did not support filtering results by service categories.
New behavior: This API fetches the employee metrics report and now supports filtering the results by service categories through the categories object in the request body.

API Endpoint: {api_url}/v1/reports/center/metrics/flat_file
Scenario: This API retrieves the center metrics report and now supports filtering through a new categories object in the request body.
API method: POST
Earlier behavior: This API fetched the center metrics report without support for filtering results by service categories.
New behavior: This API fetches the center metrics report with added support for service category filtering via the new categories object.

API Endpoint: {api_url} /v1/employees/{employee_id}/attendance
Scenario: This API fetches employee attendance and now requires the employee_id parameter to specify which employee’s records to retrieve.
API method: GET
Earlier behavior: This API fetched employee attendance without requiring an employee_id parameter.
New behavior: This API retrieves employee attendance data using the employee_id parameter, ensuring attendance is returned for the correct employee.

API Endpoint: {api_url}/v1/appointments
Scenario: This API fetches appointments for the given centerid within a date range and now accepts additional parameters aligned with the core web appointment book.
API method: GET
Earlier behavior: This API fetched appointments for the specified centerid between start_date and end_date, without support for additional appointment book parameters.
New behavior: This API retrieves appointments by centerid, start_date, and end_date, with added parameter support consistent with the core web appointment book.

API Endpoint: {api_url}/v1/employees/{employee_id}/appointment_views
Scenario: This API creates or updates the appointment scheduler view preference for an employee, persisting their selected view settings across sessions.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API stores and updates an employee’s appointment scheduler view configuration, ensuring consistent interface preferences between login sessions.

API Endpoint: {api_url}/v1/employees/{employee_id}/appointment_views
Scenario: This API retrieves the saved appointment scheduler view preference for an employee, restoring their last chosen view across sessions.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API fetches an employee’s appointment scheduler view settings, ensuring their preferred view is maintained between login sessions.