Carsync Classic client library

This project is a java library to access and use the classical (https://portal.carsync-log.de) REST API. It provides implementations for following Endpoints:

• user
• vehicle
• division
• company

but can be easily extended with other.

How to use

Basic

Provide credentials

CarsyncSession carsyncSession = new CarsyncSession("test@test.com", "password");

To access the vehicle API

VehicleService vehicleService = new VehicleServiceImpl(carsyncSession);

get all accessible vehicles

Page<Vehicle> vehiclePage = vehicleService.getList();

get one vehicle by id

Vehicle vehicle = vehicleService.get(1234);

creating and saving a vehicle

Vehicle vehicle = new Vehicle();
vehicle.setLicensePlate("AB-C 1234");
vehicle.setCountry("de");
vehicle.setManufacturer("De Dion-Bouton");
vehicle.setVehicleClass("Q 6hp");
vehicle.setFuelType("Diesel");
vehicle.setDivisionId(1234);
vehicleService.save(vehicle); // vehicle is internally updated (with id and other server-set fields)

update the vehicle

vehicle.setLicensePlate("AB-C 5678");
vehicleService.update(vehicle);

delete (for entities you can delete):

divisionService.delete(division);

or just by id

divisionService.delete(1234);

More features

Query parameters. Usually "getField" to extend the data to fetch and "field" to filter

Map<String, Serializable> params = new HashMap<>();
params.put("getDivision", 1); // get division sub object in result
params.put("active", 1); // filter active users

Page<User> userPage = userService.getList(params);

Pagination

Page<User> firstPage = userService.getList(new PaginationRangeRequest(0, 49));
Page<User> secondPage = userService.getList(new PaginationRangeRequest(50, 99));