API Reference

Get Drivers' Delivery Blocks

Gets a list of delivery blocks assigned to specified drivers by time range.

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 an error occurred, a message indicating the error.

id

Int32

The Id of this delivery block.

capacity

Int32

The number of drivers assigned to this delivery block.

description

string

The description of this delivery block.

end_time

datetime

The ending date and time of this delivery block. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

name

string

The name of this delivery block.

original_capacity

Int32

The number of drivers that should work to this delivery block.

start_time

datetime

The starting date and time of this delivery block. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_ids

array of integers

An array containing the Ids of the drivers assigned to delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.
Language