Skip to main content

JobReturnFullModel

Job return full model.

Breaking Changes

No breaking changes.

Examples

Fill this template out with real values.

{
"bin_request_id": "Integer",
"dumped_by": "Integer",
"dumped_by_driver": "Boolean",
"id": "Integer",
"original_dest_id": "Integer",
"original_dump_id": "Integer",
"returned_by": "Integer",
"returned_by_driver": "Boolean",
"truck_id": "Integer",
"yard_id": "Integer"
}

Fields

bin_request_id Integer, Required

Job identifier.


dumped_by Integer, Required

Driver or provider user ID based on dumped_by_driver state.


dumped_by_driver Boolean, Required

Job dumped by driver when TRUE.

  • One of 0, 1, True, False (case insensitive).

id Integer, Required

Resource identifier.


original_dest_id Integer, Required

Resource identifier.


original_dump_id Integer, Required

Resource identifier.


returned_by Integer, Required

Driver or provider user ID based on returned_by_driver.


returned_by_driver Boolean, Required

Job returned by driver when TRUE.

  • One of 0, 1, True, False (case insensitive).

truck_id Integer, Required

Truck identifier.


yard_id Integer, Required

Holding yard for this asset. Not null if customer_id is null and in_main_inventory is false.