Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

1. Search API URL

url : /vbs/driver/searchDriver

HTTP Method : GET

 Request
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
}

 Response
ListResponseSO<DriverSearchresponseSo> {
	List<DriverSearchResponseSo> list;
	Long totalRecords;
}
 DriverSearchResponseSo
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
(see container appt cancel api for reference- https://meatest-community.cargoes.com/vbs/swagger-ui.html#/container-appointment-controller/CA Cancel)

Path variable : 
driverIds (List<Long>)

@ModelAttribute as Query String :
  remarks: "these are remarks" (String)

 Success Response 200

[

  {

    "driverId" : "123",

    "firstName" : "Xyz",

    "lastName" : "abc"

  }

]

3. Csv Download Driver API

HTTP METHOD : GET
URI : /driver/downloadCSV
example : /vbs/driver/downloadCSV?driverIdOrName=123&contactNumber=12312
(see container appointment csv download api for reference - https://meatest-community.cargoes.com/vbs/swagger-ui.html#/container-appointment-controller/CA_CSV Download)
(Sample api which is called and file is downloaded on the mea test env for container appt csv download - https://meauat-community.cargoes.com/vbs/containerappointment/downloadCSV?ccsIdOrContNoOrContApptNo=&apptDateFrom=02%2F03%2F2023+00%3A00&apptDateTo=08%2F03%2F2023+10%3A59&lineId=MSC%2CCMA%2CCOS&appointmentType=DOE%2CDOM&truckingCompanyId=&truckingCompanyName=&subContractCompanyId=&subContractCompanyName=&bookingNo=&status=&truckVisitAppointmentNo=&clientCode=AFC00000003&site=AOLADT1)

 @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

  • No labels