Recipe 2 - Job Stop Field Definitions

Recipe 2 - Job Stop Field Definitions

Recipe 2 - Job Stop Field Definitions

The following fields are of interest when you recieve a JOB Stop status update

 

Job      
  FIELD NAME LENGTH DEFAULT/OPTIONS
  assignedDriverName
Name of Driver 
40  
  assignedDriverRemoteId
Driver who has been assigned the load, the RemoteId is the Id used in the Allocated Carriers TMS system to uniquely identify their driver                    
20  
  assignedTruckRemoteId
Truck identifier 
10  
  jobNumber
Unique Job Number generated for this load
50  
  loadId
LoadId generated from the Carriers system
10  
  status
Current status of the Job
int See Job Status's
  statusTime
Time that the status was updated by the driver
date  
  tripId
Truck trip the load was part of
20  
dropoff
Details collected at dropoff
  Location  
  quickcode
dropoff location code
50  
  eta
Drivers expected arrival time at the delivery location
date  
  proofDocUrl
URL link to the Proof of Delivery Document
   
  signoff
Signoff entity
Signoff  
  comment
Comment entered by person signoing off
300  
  notSignedReasons
A list of reasons why signature was not supplied
10  
  signedBy
Name of person signing off
100  
  url
The url to the signature
   
pickup
Details collected at pickup
  Location  
  quickcode
pickup location code
50  
  eta
Drivers expected arrival time at the pickup location
date  
  gateOutCode
Security code received when vehciles where exited from the pickup location
10  
  signoff
Signoff entity
Signoff  
  comment
Comment entered by person signoing off
300  
  notSignedReasons
A list of reasons why signature was not supplied
10  
  signedBy
Name of person signing off
100  
  url
The url to the signature
   
documents
Documents captured
  17  
  comment
Comment noted about document
300  
  type
Type of file 
int

0 - Other
2 - CollectionSignoff
3- CollectionDamage
4 - Delivery Signoff
5 - DeliveryDamage
15 - Odo Photo

  url
URL link to the file
   
vehicles
Vehicle details collected
  Vehicle  
  loadDirection
Direction the vehicle is facing on the truck
int  
  loadLevel
Level the vehicle is on
int  
  loadPosition
Load Position the vehicle is in
int  
  nonCompletionReason
Reason the vehilce was not collected
300  
  signature
URL to Signature of person signing off damage
   
  signedBy
Person who signed off the damage
100  
  signoffComment
Comment noted by signor
512  
  status
Special use case where a Vehicle is delivered by more than one truck to the final destaination
int

0 - Not Recorded
10 - Pickedup
20 - Not PickedUp
30 - Delivered
40 - Not Delivered

  Paperwork
Key / Value pairs of data collected
   
  key
Paperwork key type
   
  value
Value collected
   
  Photos
Vehicle photos collected
   
  comment
Comment noted about document
300  
  type
Type of file 
int as per documents
  url
URL link to the file