API Reference

Initiate Driver Home Events

Use to determine whether a driver is at or has departed their "home" base.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If successful, a message indicating whether the driver is "got home" or "left home". For example, "Driver Dave Smithson (ID: 81617) got home". If an error occurred, a message indicating the error.

Language