objectCreate Driver
objectGet Driver Detail
promiseGet Driver List
promiseUpdate Driver
promiseRetrieve specific driver based on the search result
promiseAPI is not ready yet Retrieve specific driver based on the search result
promiseGet Driver with filters
promiseGet Driver Counts for Dashboard
objectGet Routes
promiseGet updated driver live data for Dashboard This function will calculate all of driver counts
ObjectUpdate driver time slot
objectdeleteDriverScheduleAsync
ObjectAdd new driver time slot
objectCalculate Customer Driver Counts
Categories Customer Drivers for Count
objectCategories Customer Drivers for Count
objectCategories Customer Drivers
objectCalculate Customer Driver Counts
object
Create Driver
**Kind**: global constant
**Returns**: object - Promise resolve/reject
| Param | Type | Description |
| ---------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| driverInfo | object | {} birthday (mandatory) (string) driverTypeIds (mandatory) (string) #csv Eg. 2,3 email (mandatory) (string) existingUserEmail (optional) (boolean) firstName (mandatory) (string) identityId (mandatory) (string) isNewUser (optional) (boolean) lastName (mandatory) (string) password (mandatory) (string) phone (mandatory) (string) productTypeId (mandatory) (int) sendConfirmationSms (optional) (boolean) transactionGroupId (int) (int) vehicleBrand (optional) (string) vehicleColor (optional) (string) vehicleLicenseNumber (optional) (int) vehicleModel (optional) (string) vehicleModelYear (optional) (int) vehicleTypeId (optional) (int) |
| customerId | int | |
| token | string | |
## getDriverDetailAsync ⇒ object
Get Driver Detail
**Kind**: global constant
**Returns**: object - Promise resolve/reject
| Param | Type |
| ---------- | ------------------- |
| customerId | int |
| identityId | int |
| driverId | int |
| token | string |
## getDriversAsync ⇒ promise
Get Driver List
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type | Description |
| ------------ | ------------------- | -------------------------------------------------------------------------------------- |
| filterObject | object | {limit, page} limit (optional) (int) page (optional) (int) #offset, start from 1 value |
| token | string | |
## updateDriverAsync ⇒ promise
Update Driver
**Kind**: global constant
**Returns**: promise - reject/resolve
| Param | Type |
| ------------ | ------------------- |
| filterObject | object |
| token | string |
## getDriversBasedOnSearchResult ⇒ promise
Retrieve specific driver based on the search result
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type | Description |
| ------------ | ------------------- | -------------------------------------------------------------------------------------- |
| filterObject | object | {limit, page} limit (optional) (int) page (optional) (int) #offset, start from 1 value |
| searchResult | array | |
| token | string | |
## deleteDriversAsync ⇒ promise
API is not ready yet
Retrieve specific driver based on the search result
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type |
| ---------- | ------------------- |
| driverIds | object |
| customerId | int |
| token | string |
## getDriversWithFiltersAsync ⇒ promise
Get Driver with filters
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type | Description |
| ---------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filterObject | object | {orderRouteTypeIds, driverTypeIds, driverStatusId} orderRouteTypeIds (string) (optinal) 1,2 #csv string _ 1 means Live, 2 means POD driverTypeIds (string) (optinal) 1 #csv string _ 1 means Inhouse, 2 means Public, 3 means Service Provider driverStatusIds (string) (optinal) 1,2,3,4 #csv string \* 1 means Active, 2 means With Route, 3 means Idle, 4 means Inactive driver |
| customerId | int | |
| token | string | |
| validationStatus | boolean | (optional) |
## getDriverCountsAsync ⇒ promise
Get Driver Counts for Dashboard
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type | Description |
| ------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filterObject | object | {orderRouteTypeIds, driverTypeIds, driverStatusId} orderRouteTypeIds (string) (optinal) 1,2 #csv string _ 1 means Live, 2 means POD driverTypeIds (string) (optinal) 1 #csv string _ 1 means Inhouse, 2 means Public, 3 means Service Provider driverStatusIds (string) (optinal) 1,2,3,4 #csv string \* 1 means Active, 2 means With Route, 3 means Idle, 4 means Inactive driver |
| customerId | string | |
| token | boolean | (optional) |
## getDriverRoutesAsync ⇒ object
Get Routes
**Kind**: global constant
**Returns**: object - Promise resolve/reject
| Param | Type | Description |
| ------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filterObject | object | # {pickupDate (mandatory), withAvailability, withSchedule, limit, offset} pickupDate (optional)(string) = '2018-02-28' withAvailability (optional)(int) = 1/0 withSchedule (optional)(int) = 1/0 limit = 20 (optional)(int) page = 0 (optional)(int) |
| token | string | |
## getUpdatedDriverLiveData ⇒ promise
Get updated driver live data for Dashboard
This function will calculate all of driver counts
**Kind**: global constant
**Returns**: promise - reject/resolve
Will return [] array if there's no drivers
| Param | Type |
| ------------------- | -------------------- |
| originalDriverDatum | object |
| pubSubPayload | string |
| filterObject | boolean |
## updateDriverScheduleAsync ⇒ Object
Update driver time slot
**Kind**: global constant
**Returns**: Object - Promise resolve/reject
If resolve, return value: boolean(To indicate update successful or failed)
remarks: the API endpoint will return one of the following status:
400: Validation Error
400: Driver Schedule with same values exists
200: Success
| Param | Type | Description |
| ---------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scheduleId | int | |
| payload | object | {driverId, transactionGroupId, startTime, endTime, startDate} scheduleId (optional)(int) transactionGroupId (optional)(int) startTime (optional)(date_format:H:i) endTime (optional)(date_format:H:i) startDate (optional)(date_format:Y-m-d) |
| token | string | {driverId, transactionGroupId, startTime, endTime, startDate} |
## deleteDriverScheduleAsync ⇒ object
deleteDriverScheduleAsync
**Kind**: global constant
**Returns**: object - Promise resolve/reject
return value: boolean(To indicate delete successful or failed)
remarks: the API endpoint will return one of the following status:
404: Driver Schedule does not exists
204: Success with no content
| Param | Type |
| ---------- | ------------------- |
| scheduleId | int |
| token | string |
## createDriverScheduleAsync ⇒ Object
Add new driver time slot
**Kind**: global constant
**Returns**: Object - Promise resolve/reject
If resolve, return value: boolean(To indicate update successful or failed)
remarks: the API endpoint will return one of the following status:
400: Validation Error
400: Driver Schedule with same values exists
200: Success
| Param | Type | Description |
| ------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| payload | object | {driverId, transactionGroupId, startTime, endTime, startDate} driverId (mandatory)(int) transactionGroupId (mandatory)(int) startTime (mandatory)(date_format:H:i) endTime (mandatory)(date_format:H:i) startDate (mandatory)(date_format:Y-m-d) |
| token | string | resolve/reject |
## iterateDriverArrays ⇒ object
Calculate Customer Driver Counts
**Kind**: global constant
**Returns**: object - promise reject/resolve
| Param | Type | Description |
| ------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| drivers | object | |
| driverTypeIds | array | |
| counts | object | #{driverTypeCounts, activeStatusCounts, totalStatusCounts} driverTypeCounts: (int) 10, activeStatusCounts: (object) {1: 0, 2: 1, 3: 0, 4: 2} totalStatusCounts: (int) 20 |
| value | int | |
## getActiveStatusCountsAndTotalCounts
Categories Customer Drivers for Count
**Kind**: global constant
| Param | Type | Description |
| ------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| drivers | object | |
| driverTypeIds | array | # [1,2,3] |
| value | int | # actual filter value 2 |
| counts | object | This counts will be increased values Example driverTypeCounts: 10, activeStatusCounts: { 1: 10, 2: 10, 3: 10, 4: 10, } totalStatusCounts: 10 |
| key | string | #iteration key |
## categoriesCustomerDriversForCount ⇒ object
Categories Customer Drivers for Count
**Kind**: global constant
**Returns**: object - drivers
Example Response
{
1: {1: [], 2: [], 3: [], 4: []},
2: {1: [], 2: [], 3: [], 4: []},
3: {1: [], 2: [], 3: [], 4: []},
};
| Param | Type |
| ------- | ------------------- |
| drivers | object |
## categoriesCustomerDrivers ⇒ object
Categories Customer Drivers
**Kind**: global constant
**Returns**: object - drivers
Example Response
{
1: [], 2: [], 3: [], 4: []
};
| Param | Type |
| ------- | ------------------- |
| drivers | object |
## calculateCustomerDriverCounts(data, driverTypeIds) ⇒ object
Calculate Customer Driver Counts
**Kind**: global function
**Returns**: object - total count object of live driver data
| Param | Type |
| ------------- | ------------------- |
| data | object |
| driverTypeIds | array |