Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleRequest
Code Block
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
}

...

Expand
titleDriverSearchResponseSo
Code Block
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 pinCode;
   	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

...

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
titleResponse
Code Block
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;
}

Expand
titleDriverTerminalLocationSo
Code Block
DriverTerminalLocationSo {
   String spLocationCode;
   String spSubLocationCode;
   String portDriverId;
   LocalDate validUpto;	
}

Expand
titleDriverTruckingCompanySo
Code Block
DriverTruckingCompanySo {
	String clientCode;
    boolean defaultClient;
}

Expand
titleDriverDocumentSo
Code Block
DriverDocumentSo {
	String documentId;
    String documentType;
    String documentNumber;
    LocalDate expiryDate;
}