GuidesAPI Reference
Log In
API Reference

Initiate Driver Home Events

post
https://developer-api.bringg.com/services/d5GSvkoe0//

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

Response (Output) Params

OUTPUT PARAMS

Parameter Description

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.
Body Params
int32
required

The Id of the driver whose home status (left home or at home)

boolean
required

Indicates whether to determine if the driver is at home or left home. The values are: false or 0 - the driver not at home, true or 1 - the driver is at home.

Responses

Updated about 1 year ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago