January 2025

Version: 1.1241.0
Release Date: December 20, 2024

🔹 Summary

This release focuses on data consistency, improved tracking, and API performance. We have deprecated the v2 Civil Lawsuit Search endpoint due to performance concerns and restored v1. Additionally, we have standardized timestamps across multiple endpoints, introducing createdAtUtc and updatedAtUtc to the Offices, Firms, and Users APIs for better record tracking.

🚀 New Features & Updates

Added updatedAtUtc and createdAtUtc Timestamps to Office & Firm Endpoints

To improve data consistency and provide better tracking of record changes, the following endpoints now include updatedAtUtc and createdAtUtc fields in their responses. These timestamps align with the standard format used across other endpoints.

  • Updated GET Endpoints for Offices:

    • /api/1/offices/{firmId}
    • /api/1/offices
    • /api/1/offices/{firmId}/{officeId}
    • Change: Responses now include updatedAtUtc (last modification timestamp) and createdAtUtc (record creation timestamp).

  • Updated GET Endpoints for Firms:

    • /api/1/firms
    • /api/1/firms/{firmId}
    • Change: Responses now include updatedAtUtc and createdAtUtc for tracking entity updates.

📢 Impact:

  • No changes required for existing integrations, but consumers of these endpoints can now utilize the timestamps to track record updates more effectively.

Added updatedAtUtc and createdAtUtc to GET /api/1/users

To improve consistency across API responses, the GET /api/1/users endpoint now includes the standard timestamp properties:

  • Updated Endpoint:
    • /api/1/users
    • Change: Responses now include:
      • createdAtUtc – Timestamp indicating when the user record was created.
      • updatedAtUtc – Timestamp indicating the last modification of the user record.

📢 Impact:

  • This change does not require any updates to existing integrations but allows consumers of the API to track user record changes more effectively

Cleanup & Deprecations

  • Deprecated Civil Lawsuit Search v2 and Restored v1
    • Affected Endpoint: /api/1/Search/CivilLawsuits
    • Reason for Deprecation: The v2 version included the fullText attribute, which contained the full OCR-processed complaint text along with integrated highlights. However, processing and returning this large dataset significantly impacted performance and response times.
    • Action Required: Customers should transition back to the v1 version of /api/1/Search/CivilLawsuits, which remains fully supported.
    • Impact: If your integration relied on the fullText attribute, you may need to adjust your implementation. Alternative methods for accessing complaint text may be introduced in a future update

🐞 Bug Fixes

  • None

📢 Notes for Developers

  • Deprecation Notice: If your integration previously used the v2 Civil Lawsuit Search endpoint, transition back to v1 to avoid disruption. The fullText attribute has been removed due to performance issues.
  • New Timestamp Properties:
    • The createdAtUtc and updatedAtUtc timestamps are now available in Office, Firm, and User-related API responses.
    • These additions do not impact existing integrations but provide better tracking of data modifications.
  • Recommended Action: Developers can start leveraging these timestamps for improved auditing and data synchronization.