Change Updates

Do not miss any Garmat API changes, ever again

Subscribe to the Garmat API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /api/facilities
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • location property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address_line_1, address_line_2, city, state, working_hours, zipcode properties Added
GET /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • location property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address_line_1, address_line_2, city, distributor_name, state, working_hours, zipcode properties Added
POST /api/facilities
  • Body
  • content type Modified
    • tz property Modified
      • Property is now required
        Breaking
    • location property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • address_line_1, address_line_2, city, state, working_hours, zipcode properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • location property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address_line_1, address_line_2, city, distributor_name, state, working_hours, zipcode properties Added
PUT /api/facilities/{id}
  • Body
  • content type Modified
    • tz property Modified
      • Property is now required
        Breaking
    • location property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • address_line_1, address_line_2, city, state, working_hours, zipcode properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • location property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address_line_1, address_line_2, city, distributor_name, state, working_hours, zipcode properties Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/booths/{id}/utilization_timeline
  • Query
  • datapoints, timezone query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • interval query parameter Added
GET /api/facilities/{id}/utilization_timeline
  • Query
  • datapoints, timezone query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • interval query parameter Added
9 structure changes including:
9 Modifications
Modified 9
GET /api/booths
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • created_at property Added
GET /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • created_at property Added
GET /api/booths/{id}/utilization_timeline
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • duration property Added
GET /api/facilities
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • tz property Added
GET /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • tz property Added
GET /api/facilities/{id}/utilization_timeline
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • duration property Added
POST /api/facilities
  • Body
  • content type Modified
    • tz property Added
  • Response
  • 200 response Modified
    • content type Modified
      • tz property Added
PUT /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • created_at property Added
PUT /api/facilities/{id}
  • Body
  • content type Modified
    • tz property Added
  • Response
  • 200 response Modified
    • content type Modified
      • tz property Added
4 structure changes including:
4 Additions
Added 4
GET /api/booths/{id}/latest_values_at
GET /api/booths/{id}/utilization_stats
GET /api/facilities/{id}/utilization_summary
GET /api/facilities/{id}/utilization_timeline
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /api/booths/{id}/utilization_summary
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • active_spray property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • bake property Added
GET /api/booths/{id}/utilization_timeline
  • Query
  • timezone query parameter Added
2 structure changes including:
2 Additions
Added 2
GET /api/booths/{id}/utilization_summary
GET /api/booths/{id}/utilization_timeline
11 structure changes including:
1 Breaking change
4 Additions
7 Modifications
Modified 7 Breaking
GET /api/accounts/entities_summary
  • Path went from /api/accounts/summary to /api/accounts/entities_summary (same operationId)
    Breaking
GET /api/facilities
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • climate_control, location, region_id, region_name, square_ft, store_number, type properties Added
GET /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • climate_control, location, region_name, square_ft, store_number, type properties Added
POST /api/accounts
  • Body
  • content type Modified
    • customer_type, primary_industry properties Added
POST /api/facilities
  • Body
  • content type Modified
    • climate_control, location, square_ft, store_number, type properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • climate_control, location, region_name, square_ft, store_number, type properties Added
PUT /api/accounts/{id}
  • Body
  • content type Modified
    • customer_type, primary_industry properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • customer_type, primary_industry properties Added
PUT /api/facilities/{id}
  • Body
  • content type Modified
    • climate_control, location, square_ft, store_number, type properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • climate_control, location, region_name, square_ft, store_number, type properties Added
Added 4
DELETE /api/accounts/{account_id}/regions/{id}
GET /api/facilities/{id}/utilization
GET /api/facilities/{id}/utilization_frequency
PUT /api/accounts/{account_id}/regions/{id}
10 structure changes including:
1 Breaking change
3 Additions
6 Modifications
1 Removal
Modified 6
GET /api/booths
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • bay_count, brand_name, burner_size, height, length, model_number, motor_size, width properties Added
GET /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • bay_count, brand_name, burner_size, height, length, model_number, motor_size, width properties Added
GET /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • region_id property Added
POST /api/facilities
  • Body
  • content type Modified
    • region_id property Added
  • Response
  • 200 response Modified
    • content type Modified
      • region_id property Added
PUT /api/booths/{id}
  • Body
  • content type Modified
    • bay_count, brand_name, burner_size, height, length, model_number, motor_size, width properties Added
  • Response
  • 200 response Modified
    • content type Modified
      • bay_count, brand_name, burner_size, height, length, model_number, motor_size, width properties Added
PUT /api/facilities/{id}
  • Body
  • content type Modified
    • region_id property Added
  • Response
  • 200 response Modified
    • content type Modified
      • region_id property Added
Removed 1 Breaking
GET /api/booths/booth_status_summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /api/accounts/summary
GET /api/accounts/{account_id}/regions
POST /api/accounts/{account_id}/regions
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /api/booths/{id}/duration_by_mode
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
Added 1
GET /api/booths/booth_status_summary
49 structure changes including:
24 Breaking changes
24 Additions
1 Modification
24 Removals
Modified 1
GET /api/booths/{booth_id}/alert_history
  • Query
  • filter, sort, limit, page query parameters Added
Removed 24 Breaking
DELETE /api/api_keys/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/alert_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/latest_updates
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/duration_by_mode
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/export_csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/frequency_by_mode
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/history
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/latest_values_for
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/recent_stages
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/runtime
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/runtime_series
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/facilities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/facilities/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/facilities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/alert_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/booths/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/facilities/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 24
DELETE /api/api_keys/{id}
GET /api/alert_types
GET /api/api_keys
GET /api/booths
GET /api/booths/latest_updates
GET /api/booths/{id}
GET /api/booths/{id}/duration_by_mode
GET /api/booths/{id}/export_csv
GET /api/booths/{id}/frequency_by_mode
GET /api/booths/{id}/history
GET /api/booths/{id}/latest_values_for
GET /api/booths/{id}/recent_stages
GET /api/booths/{id}/runtime
GET /api/booths/{id}/runtime_series
GET /api/facilities
GET /api/facilities/{id}
GET /api/users
POST /api/api_keys
POST /api/facilities
POST /api/users
PUT /api/alert_types
PUT /api/booths/{id}
PUT /api/facilities/{id}
PUT /api/users/{id}
62 structure changes including:
31 Breaking changes
31 Additions
31 Removals
Removed 31 Breaking
DELETE /api/api_keys/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/accounts/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/alert_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/alerts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/latest_updates
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{booth_id}/alert_history
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/duration_by_mode
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/export_csv
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/frequency_by_mode
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/history
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/latest_values_for
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/recent_stages
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/runtime
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/booths/{id}/runtime_series
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/facilities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/facilities/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/accounts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/authenticate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/facilities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/accounts/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/alert_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/booths/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/facilities/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 31
DELETE /api/api_keys/{id}
GET /api/accounts
GET /api/accounts/{id}
GET /api/alert_types
GET /api/alerts
GET /api/api_keys
GET /api/booths
GET /api/booths/latest_updates
GET /api/booths/{booth_id}/alert_history
GET /api/booths/{id}
GET /api/booths/{id}/duration_by_mode
GET /api/booths/{id}/export_csv
GET /api/booths/{id}/frequency_by_mode
GET /api/booths/{id}/history
GET /api/booths/{id}/latest_values_for
GET /api/booths/{id}/recent_stages
GET /api/booths/{id}/runtime
GET /api/booths/{id}/runtime_series
GET /api/facilities
GET /api/facilities/{id}
GET /api/users
POST /api/accounts
POST /api/api_keys
POST /api/authenticate
POST /api/facilities
POST /api/users
PUT /api/accounts/{id}
PUT /api/alert_types
PUT /api/booths/{id}
PUT /api/facilities/{id}
PUT /api/users/{id}
8 structure changes including:
8 Modifications
Modified 8
GET /api/accounts
  • Query
  • filter, sort, limit, page query parameters Added
GET /api/booths
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
GET /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_name, facility_id properties Added
GET /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_name property Added
POST /api/facilities
  • Response
  • 200 response Modified
    • content type Modified
      • account_name property Added
POST /api/login/verify
  • Response
  • 200 response Modified
    • content type Modified
      • user_id, user_name properties Added
PUT /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_name, facility_id properties Added
PUT /api/facilities/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_name property Added