1. Search API URL
url : /driver-registration-api/driver/audit/{driverId}vbs/driver/search
DriverSearchSo is ModelAttribute on backend side where request params in url will be picked from url and mapped to entity values of DriverSearchSo in backend side (frontend has to side params which are present in below DriverSearchSo only)
sample url : /vbs/driver/searchDriver?driverIdOrName=123&contactNumber=12312...
HTTP Method : POST GET
| Expand |
|---|
|
| Code Block |
|---|
DriverSearchSo {
String driverIdOrName; // optional
String emailId; // optional
"isNextRecordRequired" : false/true, //boolean
"page" : 1 // integer
"pageSize" : 1 // integer String linkedClientCode; // optional
String contactNumber; // optional
List<String> spSubLocationCodes; // spSubLocationCode {"DPWVAN", "AOLADT1"}
String spLocationCode; // spLocationCode ""
List<String> status; // optional
String driverTerminalLocationStatus; // optional siteStatus
String portDriverId; // siteId
String clientCode; // MANDATORY where logged in user is trucking company
boolean isAdmin; // optional
} |
|
...
ListResponseSO<DriverSearchresponseSo> {
List<DriverSearchResponseSo> list;
Long |
|
...
...
...
...
Long driverId;
String firstName;
String lastName;
LocalDate dateOfBirth;
String addressLine;
String country;
|
|
...
...
String state;
String city;
String pinCode;
|
|
...
String emailId;
String countryCode;
|
|
...
...
...
...
...
...
...
2. Cancel Driver API
HTTP METHOD : DELETE
URI : /driver/cancel/{driverIds}
example : /vbs/driver/cancel/123,354?remarks=Cancelling%20the%20driver
Path variable :
driverIds (List<Long>)
@ModelAttribute as Query String :
remarks: "these are remarks" (String)
| Expand |
|---|
| title | Success Response 200 |
|---|
|
[ { "driverId" : 123, "firstName" : "Xyz", "lastName" : "abc", “processingRemarks” : “Successfully cancelled“ } ] |
Processing remarks in response can be “Successfully cancelled“ / “Already cancelled“ / “No data present or ownership issues.“.
3. Csv Download Driver API
HTTP METHOD : GET
URI : /driver/downloadCSV
example : /vbs/driver/downloadCSV?driverIdOrName=123&contactNumber=12312
| Expand |
|---|
| title | @ModelAttribute as Query string: |
|---|
|
driverIdOrName
spSubLocationCodes (of type List<String>)
spLocationCode
driverStatuses (of type List<String>)
emailId
contactNumber
clientCode (this is for logged in user)
linkedClientCode
portDriverId
driverTerminalLocationStatus
isAdmin |
Success Response 200 content type as text/csv
4. View API URL
url : /vbs/driver/{driverId}
sample url : /vbs/driver/1
HTTP Method : GET
| Expand |
|---|
|
| Code Block |
|---|
DriverDetailSo {
Long driverId;
|
|
...
...
...
...
...
...
...
...
String pincode;
String emailId;
String |
|
...
countryCode;
String contactNumber;
String |
|
...
driverStatus;
String defaultClientCode;
String |
|
...
remarks;
List<DriverTerminalLocationSo> driverTerminalLocations;
List<DriverTruckingCompanySo> driverTruckingCompanies;
List<DriverDocumentSo> driverDocuments;
} |
|
| Expand |
|---|
| title | DriverTerminalLocationSo |
|---|
|
| Code Block |
|---|
DriverTerminalLocationSo {
String |
|
...
spLocationCode;
String spSubLocationCode;
String |
|
...
portDriverId;
LocalDate validUpto;
|
|
...
| Expand |
|---|
| title | DriverTruckingCompanySo |
|---|
|
| Code Block |
|---|
DriverTruckingCompanySo {
String clientCode;
boolean defaultClient;
} |
|
| Expand |
|---|
|
| Code Block |
|---|
DriverDocumentSo {
String documentId;
String documentType;
|
|
...
...
documentNumber;
LocalDate expiryDate;
String |
|
...
5. Download Document API URL
url : /vbs/document/{documentId}
sample url : /vbs/document/48418155
HTTP Method : GET
| Expand |
|---|
|
| Code Block |
|---|
DownloadDocumentResponseSo {
Long documentId;
String |
|
...
documentType;
String documentNumber;
LocalDate expiryDate;
byte[] file;
|
|
...
...
