gRPC
The DriverTech ELD API is built using gRPC. To learn how to generate a proxy for accessing DT APIs, please visit this site: https://grpc.io/.
Administrative API
Service | Description | Parameters |
---|---|---|
AdminGetUser | Returns an updated UserModel based on the UserModel passed in. This can be requested from the server when bRequestFromServer is set to True. | UserModel, bRequestFromServer |
AdminGetLoggedOnUser | Returns the UserModel for the currently logged in user. | |
AdminGetCommInfo | Returns CommInfoModel. | |
AdminGetSystemInfo | Returns SystemInfoModel. | |
AdminGetVehicleInfo | Returns VehicleInfoModel. | |
AdminGetPosition | Returns GPSModel. | |
AdminGetLocation | Returns a string for the current location in the following format: "CITY,STATE ABBREVIATION" ex: SALT LAKE CITY,UT | |
AdminSendPosition | Sends the truck's position to the back end. | |
AdminMotionInterlock | Returns True if the vehicle is currently in motion interlock. | |
AdminGetFormAutoFill | Returns FormAutoFillModel. |
HOS API
Service | Description | Parameters |
---|---|---|
HOSWithinAYard | Returns True if the vehicle is within a Yard. | bWithinYard, bDisableGUI |
HOSIsYardModeDisabled | Returns True if Yard Move Mode is disabled. | |
HOSIsPCModeDisabled | Returns True if Personal Conveyance Mode is disabled. | |
HOSDisablePCMode | Set an additional check for Personal Conveyance Mode by passing a boolean bDisable. | bDisable |
HOSGetOverview | Returns HOSOverviewModel. |
Message API
Service | Description | Parameters |
---|---|---|
MsgGetByID | Returns a MsgModel. Create a default instance of MsgModel with the msgID and pass it as the parameter to get the other attributes returned in a MsgModel. | MsgModel |
MsgGetList | Returns a list of MsgModel's depending on the parameter passed. | MsgFolder |
MsgSend | Sends a message and returns the altered MsgModel which was passed as a parameter. | MsgModel |
MsgDelete | Deletes a message using the parameter. | MsgModel |
MsgMarkAsRead | Marks a message as read for the back end. | MsgModel |
MsgUpdateTrailers | Updates the trailers passed as parameters. | trailer1 : string, trailer2 : string, trailer3 : string |
MsgUpdateBOL | Updates the Bill of Lading. | bol : string |
MsgGetFormList | Returns a list of FormEntryModel's which will be sorted if the parameter passed is True. | bSortAlpha : bool |
MsgGetDefinition | Returns a FormDefModel. | FormDefModel |
XMessage API
Service | Description | Parameters |
---|---|---|
XMsgRxList | Returns a list of XMsgModel's. | appID : int32 |
XMsgSend | Creates a XMsgModel from the parameters that are passed and sends it. | data : bytes, thirdPartyKey : int32, timeOut : int32, appID : int32 |
XMsgGet | Returns an XMsgModel based on the parameter. | msgID : int32 |
XMsgDelete | Deletes an XMsgModel based on the parameter. | msgID : int32 |
1 Comment
Taber Loveless
Recommendations:
1) Generate the doc from the interface file ... not sure if this is possible, or could be done with code instead but will make create/maint of this doc much each (for example, see this which was generated from XSD: FleetWatcherAPI)
2) Include a 'tools and resources' section at the top of the page:
https://github.com/grpc-ecosystem/awesome-grpc
https://grpc.io/