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
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /api/booths
  • Query
  • start, includes, end query parameters Added
GET /api/bucketed_utilization
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • btu_usage, kw_usage properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • gas_usage, kwh_usage properties Added
GET /api/facilities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • btu_usage, kw_usage properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • gas_usage, kwh_usage properties Added
GET /api/utilization
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • btu_usage, kw_usage properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • gas_usage, kwh_usage properties Added
GET /api/utilization/trends
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • utilization_time property Modified
        • median_cycles property Added
6 structure changes including:
1 Addition
5 Modifications
Modified 5 Breaking
GET /api/facilities
  • Query
  • format query parameter Added
GET /api/filters/maintenance_history
  • Query
  • start, format, end query parameters Added
GET /api/filters/maintenance_timeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • region_id property Added
GET /api/filters/overuse_trend
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • all_time, current_period, pct_change properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • overuse_count, overuse_cycles, overuse_time properties Added
  • Query
  • period query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • start, end query parameters Added
GET /api/filters/services
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • region_id property Added
Added 1
GET /api/utilization/trends
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/accounts/{account_id}/regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • is_default property Added
GET /api/facilities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • events_missed, overuse_cycles, overuse_minutes, service_events properties Added
POST /api/accounts/{account_id}/regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_default property Added
PUT /api/accounts/{account_id}/regions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_default property Added
Added 1
GET /api/filters/overuse_trend
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /api/booths
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plc_program, plc_program_revision properties Added
GET /api/booths/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plc_program, plc_program_revision properties Added
GET /api/facilities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • utilization_percentage property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • btu_usage, kw_usage, utilization_minutes, working_minutes properties Added
PUT /api/booths/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plc_program, plc_program_revision properties Added
4 structure changes including:
2 Additions
2 Modifications
Modified 2
GET /api/booths/{id}/filter_maintenance_history
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • booth_overuse_cycles, booth_overuse_time properties Added
GET /api/filters/services
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • exhaust_filter, intake_filter, pre_filter properties Modified
Added 2
GET /api/filters/maintenance_history
GET /api/filters/maintenance_timeline
4 structure changes including:
1 Addition
3 Modifications
Modified 3
GET /api/accounts/{account_id}/regions
  • Query
  • search query parameter Added
GET /api/booths
  • Query
  • search query parameter Added
GET /api/facilities
  • Query
  • search query parameter Added
Added 1
GET /api/filters/services
1 structure change including:
1 Modification
Modified 1
GET /api/booths/{id}/filter_maintenances
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • exhaust_filter, intake_filter, pre_filter properties Modified
11 structure changes including:
2 Additions
9 Modifications
Modified 9
GET /api/accounts
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • regions property Added
GET /api/accounts/{account_id}/regions
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • booth_count, facility_count properties Added
GET /api/accounts/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • regions property Added
GET /api/booths
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • account_id property Added
GET /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_id property Added
POST /api/accounts
  • Response
  • 200 response Modified
    • content type Modified
      • regions property Added
POST /api/accounts/{account_id}/regions
  • Response
  • 200 response Modified
    • content type Modified
      • booth_count, facility_count properties Added
PUT /api/accounts/{account_id}/regions/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • booth_count, facility_count properties Added
PUT /api/booths/{id}
  • Response
  • 200 response Modified
    • content type Modified
      • account_id property Added
Added 2
GET /api/booths/{id}/filter_maintenance_history
GET /api/booths/{id}/filter_maintenances
1 structure change including:
1 Addition
Added 1
GET /api/bucketed_utilization
1 structure change including:
1 Modification
Modified 1
GET /api/utilization
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • btu_usage, kw_usage properties Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /api/facilities
  • Response
  • 200 response Modified
    • content type Modified
      • data property Modified
        • active_alerts, cycle_count, utilization_percentage properties Added
  • Query
  • start, includes, end query parameters Added
Added 1
GET /api/utilization
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