Web Service that serves as the link between an android tablet and the TRUX database

The following operations are supported. For a formal definition, please review the Service Description.

• HelloWorld
  
  Used to test the availability of web services.
  Any Number A string. If any value is returned, web services are available.
• WS_ASSIGNCONTAINER
  
  Assigns containers based on the action code (Truck,Site,Yard)
  truck number driver number container number date and time the container was assigned [yyyy-MM-dd hh:mm:ss] where the bin came from ValueDescription Yardcontainer came from the yard Truckcontainer was unloaded from the truck Sitecontainer was picked up from the site Offlinecontainer was moved while offline, will be converted to yard id of the source - yard would be the yard's code, truck would be truck number etc. ValueDescription Yardcontainer came from the yard Truckcontainer was unloaded from the truck Sitecontainer was picked up from the site id of the destination - yard would be the yard's code, truck would be truck number etc. lattitude where the lift took place longitude where the lift took place company code logid of the call for which the lift took place success
• WS_AUTH
• WS_CALLSRECEIVEDHANDLER
  
  Deletes calls based on the given ta01_id list
  A list of ta01_ids set to be deleted The number of calls being deleted Company Code Success
• WS_DELETEHEARTBEAT
  
  Deletes the heartbeat for the given vehicle. This is executed when the driver logs off or finishes a route
  Truck number ID of the device 2 character company code route number True on success
• WS_FINISHCALL
  
  Finishes a call in Haul-IT. This includes modifying the original call (activity or qty), creating new calls based on the driver activity code (FL04).
  the logid of the call to finish (RM03_LOGID) Route number Truck number Odometer value when the call started [int] Odometer value when the call ended [int] Driver number Route date [yyyy-MM-dd] Number of lifts completed on the call [INT] Activity the driver executed Time the call started [yyyy-MM-dd hh:mm tt] Time the call ended [yyyy-MM-dd hh:mm tt] 2 character company code ValueDescription 1Adjust the cm05 qty 0Don't adjust the cm05 qty Number of bins on site as counted by the device New service number if select by bin is active latitude when the call was started longitude when the call was started latitude when the call was finished longitude when the call was finished staged activity code if applicable True on success
• WS_GETCALLEXCEPTIONSONROUTE
  
  Gets a list of call exceptions (not this week, cancelled, etc) for the given route and date
  Route Date [yyyy-MM-dd] Truck number Route number Company code An object[CallReturn] that includes the list of call exceptions requested at a max of 'record chunk size' defined in the config file.
• WS_GETCALLSONROUTE
  
  Get a list of calls for the given route. Calls returned originate from the TA01 table.
  Route Date [yyyy-MM-dd] Truck number Route number Company Code A list of logids that already exist on the device An object[CallReturn] that inlcudes the list of calls requested, at a max of 'record chunk size' defined in the config file.
• WS_GETCOMPANIES
  
  Returns a list of companies found in SY03.
  A table filled with the companies requested. Field NameDescription CODECompany Code NAMECompany Name
• WS_GETCONTAINER
  
  Gets the requested bin. The bin will not be returned if it is not allowed on the truck
  container number truck number company code A list of containers that are on the truck. there can be multiple if the container type is linked for multiple service types
• WS_GETCONTAINERLOCATIONSBYSITE
  
  Gets containers for the given site that are compatable with the given vehicle.
  truck number customer number site number service number company code a list of containers for the given cust/site/service combination
• WS_GETCONTAINERLOCATIONSBYTRUCK
  
  Gets all available containers for the given vehicle service and all yards. this includes all available bins that are in a container yard (if the vehicle type is compatable with the container type).
  truck number customer number site number service number company code returns a list of containers for the given service and any available bins in container yards
• WS_GETCONTAINERLOCATIONSBYUNIT
  
  Gets the locations of the given containers.
  a list of containers company code a list of the given containers with corresponding locations
• WS_GETCONTAINERLOCATIONSBYYARD
  
  Gets containers for the given yard that are compatable with the given vehicle.
  truck number yard code company code a lit of containers that are allowed on the given truck that exist in the given yard
• WS_GETCONTAINERS
  
  Gets containers that can go on the truck based on truck type, route type and service type.
  The last container sent in the last batch of requested containers. The last service type sent in the last batch of requested containers. truck number Company code An object containing a list of requested containers, and some values that facilitate paging
• WS_GETCUSTSITEIMAGES
  
  Gets customer/site images
  company code a list of im09 id's that already exist on the device route route date a list of custsiteimage objects for hte given route/date and excludes images found in existingIDs
• WS_GETDIRECTMESSAGES
  
  Gets direct messages based on the criteria provided.
  driver number truck number route date [yyyy-MM-dd] route number list of message ids that exist on the device company code a list of messages based on the criteria provedied
• WS_GETDVIRREPORT
  
  Returns DVIR reports based on the dvir id's given
  list of comma separated dvir ids, empty string if getting by truck and driver truck number, -1 if getting report by id driver number, -1 if getting report by id Company code the report in byte array format
• WS_GETENGINEHOURS
  
  Get the last known engine hours for the given vehicle
  Truck number Company code Timestamp for retriving engine hours [yyyy-MM-dd hh:mm tt] The engine hours
• WS_GETINSPECTIONLISTDETAILS
  
  Gets inspection list items for the given list header
  company code issue list header all details associated with the given issue list header
• WS_GETINSPECTIONLISTHEADERS
  
  Gets all inspection list headers for the given list of trucks
  company code a list of truck numbers to get inspection list headers for a list of inspection list headers per truck
• WS_GETLIST
  
  Returns a datatable containing data for a TRUX code table depending on the tableName parameter.
  Name of the table: LM01, LM04, RM04, TR01, CD18, CD22, CD04, CM12, LM05 Company the vehicle belongs to. A datatable filled with the fields from the requested table. The columns in the table vary depending on the table returned.
• WS_GETODOMETER
  
  Gets most recent odometer value based on the given truck
  Truck number Company code The odometer value
• WS_GETONBOARDWEIGHTMATERIAL
  
  Gets the on-board weight material for the given cust/site/service combo
  Customer number Site number Service number Route number Route date [yyyy-MM-dd] 2 character company code Material code if an on-board weight material exists. Empty string if no results found
• WS_GETROUTES
  
  Get a list of routes for the desired vehicle.
  Truck number The current logged in route Company the truck belongs to [2 chars] A table with a list of routes that a driver can select based on the vehicle they are driving Field NameDescription DISPLAYRoute Number + Route Descriptoin VALUERoute Number SCHEDULEDBoolean, true if the route is currently scheduled ROUTETYPEType of Route 1 = Roll Off, 2 = Commerical, 3 = All Others
• WS_GETROUTESHEET
  
  Returns route sheet based on route and date given
  route number route date Company code the report in byte array format
• WS_GETSETTINGS
  
  Returns a list of Setting objects containing a key and value pair
  the key names to be retrieved Company the vehicle belongs to. A list of the requested settings
• WS_GETUPDATECONTAINERS
  
  Gets updates to the container list after login.
  truck number company code a list of containers that are allowed on the given truck
• WS_GETVERSION
  
  Gets the description and version number of each table form ver01.
  The company to use A table consisting of all of the code tables and their version number Field NameDescription VER01_TABLETable Name VER01_VERSIONVersion Number
• WS_HEARTBEAT
  
  Notifies the back office system that the android device is still in communication.
  Truck number 2 character company code Latitude Longitude Unique id of the device Route Number Route Date [yyyy-MM-dd] Logid of the current call Time the heartbeat was generated in the format [yyyy-MM-dd hh:mm tt] True on success
• WS_HEARTBEAT_PHONE
  
  Notifies the back office of the current position of the device.
  Latitude accurate to 6 decimal places Longitude accurate to 6 decimal places ID of the device. This id can be found in RM04_PHONE 2 character company code void
• WS_ISDISPOSALNUMBERVALID
  
  Determines if the given ticket number/facility combination has been used already.
  Ticket Number Facility Coder 2 character company code True if successful
• WS_ISVEHICLELOGGEDIN
  
  Determines if a vehicle is already logged in. If a vehicle is found in the table HB01, it is currently logged in.
  route number Truck number 2 character company code ID of the device True is the vechile is currently logged in
• WS_LOGCALLSTATUS
  
  Notifies Haul-IT that a call has been received by an Android device. This notification comes in the form of a call history record.
  Time of the Logoff [yyyy-MM-dd hh:mm tt] Logid of the call received Driver Number Status 'D'=Delivered, 'R'=Reviewed, 'S'=Started Company Code True if successful
• WS_LOGIN
  
  Updates TR03 if a TR03 record exists. If not, a TR03 record is created. Inserts a FL09 record with a FL09_START value of 1
  Route Date [yyyy-MM-dd] Current Date [yyyy-MM-dd] Time of the Login [yyyy-MM-dd hh:mm tt] Truck number Driver number Route number Current odometer reading Company Code version of the apk in the format 0.00.0000[.00] True if login is successful
• WS_LOGOFF
  
  Inserts a record into FL09, indicating to Haul-IT the driver has logged off of the route.
  Route Date [yyyy-MM-dd] Time of the Logoff [yyyy-MM-dd hh:mm tt] Route number Driver number Helper number Truck number Current odometer reading Company Code Difference between calcualed odometer and the odometer that the driver entered Engine hours Fuel Fuel UOM True if logoff is successful
• WS_MESSAGESRECEIVED
  
  Notifies TRUX that the message has been received by the device.
  an array of the messages received by the device company code success
• WS_NOTIFYSKIP
  
  Notifies Haul-IT that a call has been skipped by an Android device. This notification comes in the form of a call history record.
  Time of the Logoff [yyyy-MM-dd hh:mm tt] Logid of the call that was skipped company code True if successful
• WS_ROUTEHASCONTAINERACTIONS
  
  If the given route can have an activities on it that have a container action other than 'N'
  route number company code true if the route can contain container actions
• WS_SAVEBREADCRUMB
  
  Saves breadcrumb trail to Haul-IT
  company code list of GPSItem objects
• WS_SAVECALLSIGNATURE
  
  Saves a signature image in IM02
  Logid of the call the signature is for 2 character company code Time the signature was captured [yyyy-MM-dd hh:mm tt] The image encoded in a Base64 string Name of the person who signed True if successful
• WS_SAVECONTAINERGPS
  
  Save container gps values
  company code List of ContainerGPS object
• WS_SAVECUSTOMERSERVICEIMAGE
  
  saves customer service issue images
  Customer service issue ID (sc01_call) Image string in base64 string format Company code Success
• WS_SAVECUSTOMERSERVICEISSUE
  
  Saves a customer service issue for the given call.
  Logid of the call the customer service issue was created for. Time the issue was created [yyyy-MM-dd hh:mm tt] Driver number Customer service issue type. Subject of the CS Issue Details for the CS Issue 2 character company code True on success
• WS_SAVECUSTOMERSERVICEISSUE_AUTOCOMPLETE
  
  Saves a customer service issue for the given call.
  Logid of the call the customer service issue was created for. Time the issue was created [yyyy-MM-dd hh:mm tt] Driver number Subject of the customer service issue Details of the customer service issue 2 character company code True on success
• WS_SAVECUSTSITEGPS
  
  Save site lat longs
  company code List of CustSiteLatLong objects
• WS_SAVEDISPOSAL
  
  Creates 3 types of disposal tickets. 1 - Billable, 2 - non-billable, 3 - extra items (which are a special kind of billable ticket. To create a billable ticket, provide a logid > -1. To create a non-billable ticket, provide a logid = -1 and to create an extra items ticket, pass -1 as the ticketNumber.
  Route date [yyyy-MM-dd] Route number Logid of the call if this is a billable or an extra items ticket, -1 for a non-billable ticket. Time the ticket started [yyyy-MM-dd hh:mm tt] Time the ticket ended [yyyy-MM-dd hh:mm tt] Route date [yyyy-MM-dd] Time the ticket was saved [yyyy-MM-dd hh:mm tt] Route number String array of materials. Each element is in the format: material code~quantity~unit of measure 2 character company code bill of lading True if successful
• WS_SAVEDISPOSALIMAGE
  
  Saves a signature image in IM03
  Disposal ticket number Facility code for the disposal ticket Caption for the image The image encoded in a Base64 string 2 character company code True if successful
• WS_SAVEDOWNTIME
  
  Saves downtime to table RM07
  Route date [yyyy-MM-dd] Route number Downtime code Truck number Current odometer value [int] Time the downtime started [yyyy-MM-dd hh:mm tt] Time the downtime ended [yyyy-MM-dd hh:mm tt] 2 character company code True if successful
• WS_SAVEDVIR
  Saves a dvir to the database company code dvir object to save a dvir object containing all generated ids
• WS_SAVEDVIRDETAILIMAGE
  
  Saves a dvir image to the database
  company code dvir detail image success
• WS_SAVEEXTRA
  
  Saves an extra call in the FL08 table. This means it will go into the database as a 'route exception'.
  Route number Route date [yyyy-MM-dd] Latitude where the call was finished Longitude where the call was finished Current odometer value [int] Logid of the call the extra lift is for Size of the bin lifted Service type of the service being lifted. Activity code for the extra lift Number of lifts Driver number of the driver who did the extra call 2 character company code FL08_ID of the new call
• WS_SAVEEXTRADISPOSALIMAGE
  
  Saves a signature image in IM03
  Disposal ticket number Facility code for the disposal ticket Caption for the image The image encoded in a Base64 string 2 character company code True if successful
• WS_SAVEEXTRAIMAGE
  
  Saves images attached to an extra lift in FL08a
  the id of the extra lift (FL08_ID) image caption the image as a base64 string determines if the image is a signature ValueDescription 1Image is a signature 0Image isn't a signature 2 character company code success
• WS_SAVEIMAGE
  
  Saves a call image in IM01
  Logid of the call that was skipped Caption for the image The image encoded in a Base64 string 2 character company code True if successful
• WS_SAVELEED
  
  Save LEED breakdowns
  list of LEEDBreakdownItem objects 2 character company code True on success
• WS_SAVEONBOARDWEIGHT
  
  Creates an on-board weight disposal ticket. This method will create any number of disposal tickets for the same call since the ticket number for each call to this method is unique.
  Logid of the call the on-board wieght came from. Weight of the material [double] Material that was picked up On-board scale unit of measure used in the weight cap calculation time the bin was lifted [yyyy-MM-dd mm:hh tt] 2 character company code list of leed breakdown items True on success
• WS_SAVEUNFINISHEDCALLS
  
  Saved unfinished calls from the android device back into TA01, ready for another vehicle to pick them up
  String array of logids to be saved to TA01 Truck number Route date [yyyy-MM-dd] 4 digit route number 2 character company code True on success
• WS_SENDLOG
  
  Emails the current log to the address specified in TRUX
  ID of the device The file to be emailed Name of the file company code success
• WS_UPDATECALLS
  
  Updates calls from the android device that are in the calls table that don't match the currently logged in route and date
  company code date [yyyy-MM-dd] route number a list of logids that exist on the device a list of calls requiring actions on the device
• WS_UPDATEGPS
  
  Updates both cm05 gps and ci01 gps values. If a lat/long pair is unavailable, pass -1.
  customer number site number service number bin lat bin long call lat call long route date company code success
• WS_UPDATEINSPECTIONLISTSTATUS
  
  Updates the inspection list status (if the truck has an assocaited inspection item list and if the pre-trip has been done for this truck
  company code a list of trucks to get the dvir status for A list of truck objects which contains information on the current dvir status
• WS_UPDATEMESSAGEINTERACTIONS
  
  Notifies TRUX that the message has been confirmed by the driver.
  an array of messages that have been confirmed comapny code success
• WS_UPDATEROUTESTATUS
  
  starts or stops the route based on the stopped parameter.
  Route Date [yyyy-MM-dd] Route number starts or stops the route ValueDescription 1Stop the route 0Start the route Downtime reason code Company code Success
• WS_USEBREADCRUMB
  
  Determines if the truck,route or driver is to use the breadcrumb trail.
  company code truck route driver returns true if one of the parameters is to use the breadcrumb trail
• WS_VALIDATEAPKVERSION
  
  Compares the apk version passed in to the version we have saved in the database. The version in the database is the newest version that has been encountered by the api. This ensures all tablets are running the same version when upgrading. (minor version numbers are not counted here)
  The version number of the app in the format '0.00.0000' validation error message if the passed in version is < the apk version saved in the db
• WS_VALIDATEVERSION
  
  Compares the version passed to the method to version of web services. If the version passed in is greater than the version number of web services, the method will return false.
  The version number of the app in the format '0.00.0000' true if valid