Change Updates

Do not miss any eKare - Public API changes, ever again

Subscribe to the eKare - Public API changelog to be up to date on recent changes.

RSS

Feb 24, 2025

main
1.0.0
Compare

API structure has changed

3 structure changes including:
3 Breaking changes
3 Modifications
Modified 3 Breaking
GET /api/v1/measurements
  • Path went from /api/v1/wounds/{wound_id}/measurements to /api/v1/measurements (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • type query parameter Modified
      • Type went from number to string
        Breaking
    • id, date, avg_depth, max_depth, max_width, max_length, perimeter, area, volume, granulation, slough, eschar, is_locked, created_at, updated_at query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • images property Modified
GET /api/v1/patients
  • Path went from /api/v1/sites/{site_id}/patients to /api/v1/patients (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • clinic_id query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • id, first_name, last_name, mrn, dob, gender, phone, address, zip, created_at query parameters Added
  • site_id query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • site_id property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 404 response Added
GET /api/v1/wounds
  • Path went from /api/v1/patients/{patient_id}/wounds to /api/v1/wounds (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • is_locked query parameter Modified
      • Type went from string to boolean
        Breaking
    • id, onset_date, type, secondary_type, primary_location, secondary_location, is_front, created_at, updated_at query parameters Added
  • patient_id query parameter Added
  • Path
  • patient_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking