Movement

GET /api/dashboard/movement

Headers

  • Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

  • date_start string(date-time) Required

    date_start

  • offset integer(int64)
  • pageNumber integer(int32)
  • pageSize integer(int32)
  • paged boolean
  • unpaged boolean
  • date_end string(date-time)

    date_end

  • yard_id integer(int64)

    yard_id

  • carrier_id integer(int64)

    A carrier id to filter, or a list of carrier ids separated by commas

  • status string

    A status to filter, or a list of status separated by commas. eg.: LOADED,EMPTY

    Values are EMPTY, LOADED, or NO_TRAILER.

  • When this parameter is present and true, then the Other Carriers will be returned as long as the caller account is allowed to see other carriers (field canViewOtherCarriers=true). When this parameter is present and false, then the Other Carriers will not be returned, regardless user permissions. Finally when this parameter is not present, then the Other Carriers will be returned by default if and only if the user is allowed to see Other Carriers (and won't be returned if the user is not allowed to see them)

  • visit_type

    Values are TRACTOR or VEHICLE.

  • filter string

    filter

Responses

GET /api/dashboard/movement
curl \
 -X GET https://api-dev.gatego.io:443/api/dashboard/movement?date_start=2024-05-04T09%3A42%3A00%2B00%3A00
Response examples (200)
{"content"=>[{"age_days"=>42, "attachment_ids"=>[42], "attachment_picture_ids"=>[42], "bill_of_lading_photo_id"=>42, "bol_number"=>"string", "chassis_number"=>"string", "chassis_size"=>"string", "comments"=>"string", "created_at"=>"2024-05-04T09:42:00+00:00", "created_by"=>"string", "custom_fields"=>{"key"=>"string"}, "damage"=>"string", "damage_asset_type"=>"string", "damage_attachment_ids"=>[42], "damage_id"=>42, "damage_picture_ids"=>[42], "damage_reference"=>"string", "damage_status"=>"string", "destination"=>"string", "direction"=>"IN", "driver_id"=>42, "driver_license"=>"string", "driver_license_expiration"=>"2024-05-04T09:42:00+00:00", "driver_license_picture_id"=>42, "driver_name"=>"string", "driver_photo_id"=>42, "driver_safety_card_picture_id"=>42, "extra_trailers"=>[{"carrier_id"=>42, "carrier_name"=>"string", "client"=>"string", "destination"=>"string", "id"=>42, "inside_picture_id"=>42, "left_image_id"=>42, "load"=>"string", "movement_id"=>42, "movement_trailer_number"=>"string", "no_seal"=>true, "number"=>"string", "other_carrier"=>"string", "priority"=>true, "purpose"=>"string", "rear_picture_id"=>42, "right_image_id"=>42, "seal"=>"string", "seal_picture_ids"=>[42], "shipment_id"=>"string", "sku"=>"string", "status"=>"EMPTY", "status_desc"=>"string", "tags"=>[{"color"=>"string", "created_at"=>"2024-05-04T09:42:00+00:00", "id"=>42, "last_modified_at"=>"2024-05-04T09:42:00+00:00", "name"=>"string"}], "trailer_location"=>{"level"=>"string", "row"=>"string", "values"=>["string"], "zone"=>"string"}, "trailer_out_movement_id"=>42, "trailer_stay_seconds"=>42, "type"=>"string"}], "id"=>42, "inside_trailer_picture_id"=>42, "inspections"=>[{"attachments"=>[{"attachment_id"=>42, "name"=>"string"}], "created_at"=>"2024-05-04T09:42:00+00:00", "id"=>42, "inspection_content"=>{}, "inspection_type"=>"string", "last_modified_at"=>"2024-05-04T09:42:00+00:00", "trailer_id"=>42, "trailer_number"=>"string", "truck_id"=>42, "truck_number"=>"string", "yard_movement_id"=>42}], "last_modified_at"=>"2024-05-04T09:42:00+00:00", "last_modified_by"=>"string", "left_trailer_image_id"=>42, "license_plate_photo_id"=>42, "load"=>"string", "movement_driver_name"=>"string", "movement_driver_photo_id"=>42, "movement_timestamp"=>"2024-05-04T09:42:00+00:00", "no_seal"=>true, "other_trailer_carrier"=>"string", "other_truck_carrier"=>"string", "pager_number"=>"string", "purpose"=>"string", "rear_trailer_picture_id"=>42, "right_trailer_image_id"=>42, "safety_video_confirmation"=>true, "seal"=>"string", "seal_picture_ids"=>[42], "shipment_id"=>"string", "sku"=>"string", "spare_tire_truck_photo_id"=>42, "status"=>"string", "tanker_status"=>"string", "trailer"=>"string", "trailer_carrier_id"=>42, "trailer_carrier_name"=>"string", "trailer_client"=>"string", "trailer_id"=>42, "trailer_invalidated"=>true, "trailer_location"=>{"level"=>"string", "row"=>"string", "values"=>["string"], "zone"=>"string"}, "trailer_number"=>"string", "trailer_number_inference"=>"string", "trailer_out_movement_id"=>42, "trailer_priority"=>true, "trailer_stay_seconds"=>42, "trailer_tags"=>[{"color"=>"string", "created_at"=>"2024-05-04T09:42:00+00:00", "id"=>42, "last_modified_at"=>"2024-05-04T09:42:00+00:00", "name"=>"string"}], "trailer_type"=>"string", "truck_carrier_id"=>42, "truck_carrier_info_photo_id"=>42, "truck_carrier_name"=>"string", "truck_class"=>"CLASS_2B_3", "truck_fuel_type"=>"CNG", "truck_id"=>42, "truck_image_id"=>42, "truck_invalidated"=>true, "truck_left_photo_id"=>42, "truck_number"=>"string", "truck_out_movement_id"=>42, "truck_right_photo_id"=>42, "truck_stay_seconds"=>42, "truck_type"=>"BOX", "vehicle_image_id"=>42, "visit_type"=>"string", "visitor_badge_number"=>"string", "visitor_company"=>"string", "visitor_email"=>"string", "visitor_host"=>"string", "visitor_host_account_id"=>42, "visitor_name"=>"string", "visitor_person_photo_id"=>42, "visitor_phone_number"=>"string", "visitor_type"=>"PERSON", "wash_out_slip_photo_id"=>42, "yard_address"=>"string", "yard_id"=>42, "yard_name"=>"string", "yard_place_id"=>"string"}], "empty"=>true, "first"=>true, "last"=>true, "number"=>42, "number_of_elements"=>42, "pageable"=>{"offset"=>42, "page_number"=>42, "page_size"=>42, "paged"=>true, "sort"=>{"empty"=>true, "sorted"=>true, "unsorted"=>true}, "unpaged"=>true}, "size"=>42, "sort"=>{"empty"=>true, "sorted"=>true, "unsorted"=>true}, "total_elements"=>42, "total_pages"=>42}