Page Comparison

1. Search API URL

url : /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 : GET

DriverSearchSo {
	private String driverIdOrName; // optional
  	private String emailId; // optional
  	private String linkedClientCode; // optional
  	private String contactNumber; // optional
  	private List<String> spSubLocationCodes; //  spSubLocationCode {"DPWVAN", "AOLADT1"}
  	private String spLocationCode; // spLocationCode ""
  	private List<String> status; // optional
  	private String driverTerminalLocationStatus; // optional siteStatus
  	private String portDriverId; // siteId
  	private String clientCode; // MANDATORY where logged in user is trucking company
  	private boolean isAdmin; // optional
}

...

DriverSearchResponseSo {
	private Long driverId;
	private    String firstName;
	private    String lastName;
	private    LocalDate dateOfBirth;
	private    String addressLine;
	private    String country;
	private    String state;
	private    String city;
	private    String pincodepinCode;
   	private String emailId;
   	private String countryCode;
	private    String contactNumber;
   	private String driverStatus;
	private    String clientCode;	
}

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>)

...

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

Success Response 200 content type as text/csv

4. View API URL

url : /vbs/driver/{driverId}

sample url : /vbs/driver/1

HTTP Method : GET

DriverDetailSo {
	Long driverId;
    String firstName;
    String lastName;
    LocalDate dateOfBirth;
    String addressLine;
    String country;
    String state;
    String city;
    String pincode;
    String emailId;
    String countryCode;
    String contactNumber;
    String driverStatus;
    String defaultClientCode;
    String remarks;
    List<DriverTerminalLocationSo> driverTerminalLocations;
    List<DriverTruckingCompanySo> driverTruckingCompanies;
    List<DriverDocumentSo> driverDocuments;
}

DriverTerminalLocationSo {
   String spLocationCode;
   String spSubLocationCode;
   String portDriverId;
   LocalDate validUpto;	
}

DriverTruckingCompanySo {
	String clientCode;
    boolean defaultClient;
}

DriverDocumentSo {
	String documentId;
    String documentType;
    String documentNumber;
    LocalDate expiryDate;
    String documentName;
}

5. Download Document API URL

url : /vbs/document/{documentId}

sample url : /vbs/document/48418155

HTTP Method : GET

DownloadDocumentResponseSo {
	Long documentId;
    String documentType;
    String documentNumber;
    LocalDate expiryDate;
    byte[] file;
    String message;
}