all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getDeliveryDrivers
Human Readable Name or Caption:
Get Delivery Drivers
Page/Function Description:
This method will get delivery driver data.
Page/Function Output Type:
API - JSON or WDDX
Categories:
invoice,customer
Extra Page/Function Notes:
This method will get delivery driver data if the delivery option is set up.


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_ID Numeric 0 Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
QRY_DELIVERY_DRIVER_INFO_ARRAY Array This is the query result for the main delivery driver details. This result set will include things such as: default vehicle id, default vehicle name, driver id, license number, driver name, payee EIN, payee id and driver status.
DEFAULT_VEHICLE_ID Numeric This is the default vehicle id. This is the default vehicle id assigned to the specific delivery driver (example: 2).
DEFAULT_VEHICLE_NAME String This is the default vehicle name. This is the default vehicle name assigned to the specific delivery driver (example: Subaru).
DRIVER_ID Numeric This is the driver identification number. This is the internal Adilas driver identification number for your corporation (from 1 to the number of drivers. example: 5).
LICENSE_NUMBER String This is the driver's license number. This is the driver's license number (example: 1234567-1234)
NAME String This is the driver's name. This is the full name of the driver (example. John Doe).
PAYEE_EIN String This is the payee EIN number. This is the payee tax id/employer identification number (example: 12-3456789) .
PAYEE_ID Numeric This is the payee identification number. This is the Adilas payee identification number (example: 5130).
STATUS Numeric This is the driver status. This is the driver status within the corporation (1 = Active, 0 = Inactive).
PAYEE_CELL_PHONE String This is the payee cell phone number. This is the payee (driver) identification number (example: 435-780-5130).
PAYEE_EMAIL String This is the payee email. This is the payee (driver) email address (example: joe@gmail.com).


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getDeliveryDrivers","CORP_ID":53,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}