Change Updates

Do not miss any gatego API changes, ever again

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

RSS

Jun 19, 2024

main
v1
Compare

API structure has changed

49 structure changes including:
1 Addition
48 Modifications
Modified 48 Breaking
GET /api/account/me
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
GET /api/yardmovement-precheck/search
  • Response
  • 200 response Modified
    • */* content type Modified
  • Query
  • date_start, date_end query parameters Added
GET /api/yardmovement-precheck/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
PATCH /api/account/{id}
  • Body
  • application/json content type Modified
    • driver_safety_card_picture_id property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
PATCH /api/carrier/{id}
  • Body
  • application/json content type Modified
    • yards property Added
PATCH /api/driver/{id}
  • Body
  • application/json content type Modified
    • safety_card_picture_id property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • account property Modified
      • safety_card_picture_id property Added
PATCH /api/organization/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • created_at property Added
PATCH /api/trailer/{id}
  • Body
  • application/json content type Modified
    • custom_fields property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • custom_fields property Added
PATCH /api/yard/{yardId}/movement/{id}
  • Body
  • application/json content type Modified
    • extra_trailers property Modified
    • main_trailer property Modified
      • custom_fields property Added
    • damage, damage_asset_type, damage_attachment_ids, damage_picture_ids, damage_reference properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
PATCH /api/yardmovement-precheck/{id}
  • Body
  • application/json content type Modified
    • extra_trailers property Modified
    • main_trailer property Modified
      • custom_fields property Added
    • damage, damage_asset_type, damage_attachment_ids, damage_picture_ids, damage_reference properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
POST /api/account
  • Body
  • application/json content type Modified
    • role property Modified

      • Property is no longer required

      • role property Modified

        • Property is no longer required

    • driver_license, driver_license_expiration, driver_license_picture_id, driver_photo_id, driver_truck_carrier_id, driver_truck_fuel_type, driver_truck_id, driver_truck_number, driver_truck_type, username properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 201 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
POST /api/carrier
  • Body
  • application/json content type Modified
    • yards property Added
POST /api/driver
  • Body
  • application/json content type Modified
    • safety_card_picture_id property Added
  • Response
  • 201 response Modified
    • */* content type Modified
      • account property Modified
      • safety_card_picture_id property Added
POST /api/organization
  • Response
  • 201 response Modified
    • */* content type Modified
      • created_at property Added
POST /api/public/account/invited-account
  • Body
  • application/json content type Modified
    • account_invited property Modified

      • Full types is no longer object

        Breaking

      • driver_license, driver_license_expiration, driver_license_picture_id, driver_photo_id, driver_truck_carrier_id, driver_truck_fuel_type, driver_truck_id, driver_truck_number, driver_truck_type, language_code, managed_organization_group_id, name, password, password_confirmation, phone_number, username properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Response
  • 201 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
POST /api/trailer
  • Body
  • application/json content type Modified
    • custom_fields property Added
  • Response
  • 201 response Modified
    • */* content type Modified
      • custom_fields property Added
POST /api/yard/{yardId}/movement
  • Body
  • application/json content type Modified
    • extra_trailers property Modified
    • main_trailer property Modified
      • custom_fields property Added
    • damage, damage_asset_type, damage_attachment_ids, damage_picture_ids, damage_reference properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
  • Response
  • 201 response Modified
    • */* content type Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
POST /api/yardmovement-precheck
  • Body
  • application/json content type Modified
    • extra_trailers property Modified
    • main_trailer property Modified
      • custom_fields property Added
    • damage, damage_asset_type, damage_attachment_ids, damage_picture_ids, damage_reference properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
  • Response
  • 201 response Modified
    • */* content type Modified
      • driver property Modified
POST /api/yardmovement-precheck/{id}/gatepass
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
POST /api/yardmovement-precheck/{id}/gatepass/send
  • Body
  • application/json content type Modified
    • driver property Modified
      • notification_name property Added
POST /signup
  • Body
  • application/json content type Modified
    • account property Modified
      • can_view_carrier_ids, carrier_id, driver_license, driver_license_expiration, driver_license_picture_id, driver_photo_id, driver_truck_carrier_id, driver_truck_id, driver_truck_number properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • account, organization properties Modified
POST /signup/check
  • Body
  • application/json content type Modified
    • account_username property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • account_username_exists property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

PUT /api/carrier
  • Body
  • application/json content type Modified
    • yards property Added
PUT /api/driver
  • Body
  • application/json content type Modified
    • safety_card_picture_id property Added
  • Response
  • 200 response Modified
    • */* content type Modified
      • account property Modified
      • safety_card_picture_id property Added
PUT /api/trailer
  • Response
  • 200 response Modified
    • */* content type Modified
      • custom_fields property Added
GET /api/account/search/byUsername
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
GET /api/account/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • driver_safety_card_picture_id property Added
GET /api/dashboard/movement
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/dashboard/summary/trailer
  • Response
  • 200 response Modified
    • */* content type Modified
      • custom_fields property Added
GET /api/dashboard/yard/trailer
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/dashboard/yard/truck
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/driver/check
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
GET /api/driver/search
  • Response
  • 200 response Modified
    • */* content type Modified
GET /api/driver/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • account property Modified
      • safety_card_picture_id property Added
GET /api/fallback/dashboard/movement
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/fallback/dashboard/yard/trailer
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/fallback/dashboard/yard/truck
  • Response
  • 200 response Modified
    • */* content type Modified
      • content property Modified
GET /api/movement/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
GET /api/organization
  • Response
  • 200 response Modified
    • */* content type Modified
GET /api/organization/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • created_at property Added
GET /api/public/shared/movement/{uuid}
  • Response
  • 200 response Modified
    • */* content type Modified
      • spare_tire_truck_photo_id, truck_left_photo_id, truck_right_photo_id properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • bill_of_lading_photo_shared_id, bol_number, driver_license_picture_shared_id, driver_photo_shared_id, driver_safety_card_picture_shared_id, license_plate_photo_shared_id, movement_driver_name, movement_driver_photo_shared_id, pager_number, safety_video_confirmation, spare_tire_truck_photo_shared_id, tanker_status, truck_carrier_info_photo_shared_id, truck_left_photo_shared_id, truck_right_photo_shared_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_name, visitor_person_photo_shared_id, visitor_phone_number, visitor_type, wash_out_slip_photo_shared_id properties Added
GET /api/trailer/byNumberAndCarrier/{number}{carrierId}
  • Response
  • 200 response Modified
    • */* content type Modified
      • custom_fields property Added
GET /api/trailer/search
  • Response
  • 200 response Modified
    • */* content type Modified
GET /api/trailer/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • custom_fields property Added
GET /api/yard/{yardId}/movement/{id}
  • Response
  • 200 response Modified
    • */* content type Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
GET /api/yard/{yardId}/truck
  • Response
  • 200 response Modified
    • */* content type Modified
GET /api/yardmovement-precheck
  • Response
  • 200 response Modified
    • */* content type Modified
  • Query
  • date_start, date_end query parameters Added
GET /api/yardmovement-precheck/gatepass/{gatepassCode}
  • Response
  • 200 response Modified
    • */* content type Modified
      • driver property Modified
      • bill_of_lading_photo_id, bol_number, driver_safety_card_picture_id, license_plate_photo_id, movement_driver_photo_id, pager_number, safety_video_confirmation, tanker_status, trailer_custom_fields, truck_carrier_info_photo_id, visitor_badge_number, visitor_company, visitor_email, visitor_host, visitor_host_account_id, visitor_name, visitor_person_photo_id, visitor_phone_number, visitor_type, wash_out_slip_photo_id properties Added
Added 1
DELETE /api/attachment/{id}