Data
ARData
This object describe all the datas managed by the SDK.
It contains:
operations: List ofAROperation(deliveries, collections, ...)sites: List ofARSite(clients, plants, ...)trucks: List ofARTrucktrailers: List ofARTrailertripProfile: Definition of theTrip Profileto be used for distances and durations calculationsrouteProfile: Definition of theRoute Profileto be used for route optimizationvehicleTypes: List ofVehicle TypetimeProfiles: List ofOpening Timesprofilesproducts: List ofProductslogicticProfiles: List ofLogistic Profilespois: List of WebviewPOIreferencePlanning: API MPT Solution to display the routesmciIndependantJobs: List of jobDataIndependantJob to be used for itinerary displaymciRouteLinks: List of jobDataRouteLink to be used for route itinerary display
Note for Route calculation
Example
Small Data Set
{
"sites": [
{
"id": "Depot",
"coordinates": {
"longitude": 5.852579,
"latitude": 49.825763
},
"isDepot": true,
"timesProfilesForLoading": [
{
"idProfile": "PROFILE_T01",
"idProductFamily": "DEFAUT"
}
],
"timesProfilesForUnloading": [
{
"idProfile": "PROFILE_T02",
"idProductFamily": "DEFAUT"
}
],
"logisticProfilesForLoading": [
{
"idProfile": "PROFILE_L01",
"idProductFamily": "DEFAUT"
}
],
"logisticProfilesForUnloading": [
{
"idProfile": "PROFILE_L02",
"idProductFamily": "DEFAUT"
}
],
"fixedTimeManagementRule": "LONGEST_TIME",
"flowManagementRule": "LONGEST_TIME",
"entityType": "SITE"
},
{
"id": "Client",
"coordinates": {
"longitude": 5.2891,
"latitude": 50.10963
},
"isDepot": false,
"timesProfilesForLoading": [
{
"idProfile": "PROFILE_T02",
"idProductFamily": "DEFAUT"
}
],
"timesProfilesForUnloading": [
{
"idProfile": "PROFILE_T01",
"idProductFamily": "DEFAUT"
}
],
"logisticProfilesForLoading": [
{
"idProfile": "PROFILE_L02",
"idProductFamily": "DEFAUT"
}
],
"logisticProfilesForUnloading": [
{
"idProfile": "PROFILE_L01",
"idProductFamily": "DEFAUT"
}
],
"fixedTimeManagementRule": "LONGEST_TIME",
"flowManagementRule": "LONGEST_TIME",
"entityType": "SITE"
}
],
"trucks": [
{
"id": "Truck1",
"availablePeriods": [
{
"id": "DEFAUT",
"timeWindow": {
"start": "2023-10-19T05:00:00.000+02:00",
"end": "2023-10-19T16:30:00.000+02:00"
},
"departureSite": "Depot",
"arrivalSite": "Depot",
"maxWorkingTime": 43200,
"maxDrivingTime": 36000,
"usePriority": 0,
"maxRoutes": 2,
"idLegislationProfile": "DEFAUT"
}
],
"idVehicleType": "17000",
"costs": {
"fixedCostByUsedPeriod": 0,
"workingDayCost": 0,
"workingNightCost": 0,
"distanceCost": 0
},
"entityType": "TRUCK"
}
],
"trailers": [],
"operations": [
{
"id": "OT1",
"type": "COLLECTION",
"earliestLatestDatesOnOrigin": {
"start": "2023-10-19T06:00:00.000+02:00",
"end": "2023-10-19T16:00:00.000+02:00"
},
"earliestLatestDatesOnDestination": {
"start": "2023-10-19T00:00:00.000+02:00",
"end": "2023-10-19T23:59:00.000+02:00"
},
"idSiteOrigin": "Client",
"idxSplit": 0,
"idxPassage": 1,
"weight": 165,
"volume": 165,
"handlingQuantity": 165,
"idProduct": "résiduels",
"idTimeProfileOnOrigin": "B_0000_DEFAUT",
"idLogisticProfileOnOrigin": "L_DEFAUT_DEFAUT_NNNNONNNNNNNNNNN9900",
"priority": 0,
"splittable": true,
"truckAssignment": {
"idTruck": "1NNC908"
},
"fixedProduct": true,
"entityType": "OPERATION",
"isAffected": false,
"isRejected": false
},
{
"id": "OT2",
"type": "DELIVERY",
"earliestLatestDatesOnOrigin": {
"start": "2023-10-19T06:00:00.000+02:00",
"end": "2023-10-19T16:00:00.000+02:00"
},
"earliestLatestDatesOnDestination": {
"start": "2023-10-19T00:00:00.000+02:00",
"end": "2023-10-19T23:59:00.000+02:00"
},
"idSiteOrigin": "Depot",
"idxSplit": 0,
"idxPassage": 1,
"weight": 165,
"volume": 165,
"handlingQuantity": 165,
"idProduct": "résiduels",
"idTimeProfileOnOrigin": "PROFILE_T01",
"idLogisticProfileOnOrigin": "PROFILE_L01",
"priority": 0,
"splittable": true,
"truckAssignment": {
"idTruck": "Truck1"
},
"fixedProduct": true,
"entityType": "OPERATION",
"isAffected": false,
"isRejected": false
}
],
"pois": [],
"mciRouteLinks": [],
"mciIndependantJobs": [],
"tripProfile": {
"speedPreferences": [
{
"category": "PENALIZED_LOCAL_ROAD_SPEED",
"speed": 21,
"preferenceIndicator": 0
},
{
"category": "LOCAL_ROAD_SPEED",
"speed": 30,
"preferenceIndicator": 0
},
{
"category": "PENALIZED_SECONDARY_ROAD_SPEED",
"speed": 25,
"preferenceIndicator": 0
},
{
"category": "SECONDARY_ROAD_SPEED",
"speed": 50,
"preferenceIndicator": 0
},
{
"category": "PENALIZED_MAJOR_ROAD_SPEED",
"speed": 35,
"preferenceIndicator": 0
},
{
"category": "MAJOR_ROAD_SPEED",
"speed": 70,
"preferenceIndicator": 0
},
{
"category": "EXPRESSWAY_SPEED",
"speed": 80,
"preferenceIndicator": 0
},
{
"category": "MOTORWAY_SPEED",
"speed": 80,
"preferenceIndicator": 0
}
],
"calculationMode": "THE_FASTEST",
"useTruckRestrictions": true,
"withTurnRestrictions": false,
"useCosts": false,
"useVariableSpeed": true,
"useOncoming": false,
"speedprofilealternativity": 0,
"minimalDistance": 0,
"minimalDuration": 0,
"avoidTolls": true,
"avoidBoatLinks": true,
"hourlyCosts": 0,
"truckAttributes": {},
"resolutionMode": "EXACT",
"useBiDirectionnalSites": true,
"name": "DEFAUT",
"description": ""
},
"routeProfile": {
"name": "PROFILE_R01",
"language": "FR",
"calculationParameters": [
{
"code": "pg310",
"value": 0
},
{
"code": "pg1900",
"value": 108000
}
],
"valorizations": {
"solution": [
{
"criteria": [
"NB_REJECTED_OPERATIONS"
]
},
{
"criteria": [
"DISTANCE"
]
}
]
},
"unitOfCompartments": "VOLUME",
"unitOfDepotAssignmentScopeQuantities": "WEIGHT",
"distancePrecision": "HECTOMETER",
"timePrecision": "MINUTE",
"nightDefinition": {
"start": "22:00:00",
"end": "06:00:00",
"timeZone": "Europe/Paris"
}
},
"vehicleTypes": [
{
"id": "15000",
"weightCapacity": 99999,
"volumeCapacity": 15000,
"size": 1,
"unloadedWeight": 0,
"availableCharacteristics": [
"240 L",
"360 L",
"400 L",
"660 L",
"1100 L"
],
"compartConfiguration": {
"id": "1",
"accessMode": "FROM_THE_REAR_OF_THE_VEHICLE",
"compartments": [
{
"maximalSize": 15000,
"minimalSize": 15000,
"incrementSize": 0,
"fillRule": "OPERATIONS_WITH_SAME_PRODUCT"
}
],
"maxCapacity": 15000
},
"maxSitesPerRoute": 1,
"acceptCollectionsOnlyAfterDeliveries": false
},
{
"id": "17000",
"weightCapacity": 17000,
"volumeCapacity": 17000,
"size": 1,
"unloadedWeight": 0,
"availableCharacteristics": [
"240 L",
"360 L",
"400 L",
"660 L",
"1100 L",
"2500 L",
"3000 L",
"5000 L"
],
"compartConfiguration": {
"id": "1",
"accessMode": "FROM_THE_REAR_OF_THE_VEHICLE",
"compartments": [
{
"maximalSize": 17000,
"minimalSize": 17000,
"incrementSize": 0,
"fillRule": "OPERATIONS_WITH_SAME_PRODUCT"
}
],
"maxCapacity": 17000
},
"maxSitesPerRoute": 1,
"acceptCollectionsOnlyAfterDeliveries": false
}
],
"timeProfiles": [
{
"id": "PROFILE_T01",
"openingTime": {
"recurrentTimeWindows": [
{
"days": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"startTime": "08:00",
"timeRange": 43140,
"timeZone": "Europe/Paris"
}
]
}
},
{
"id": "PROFILE_T02",
"openingTime": {
"recurrentTimeWindows": [
{
"days": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"startTime": "00:00",
"timeRange": 86340,
"timeZone": "Europe/Paris"
}
]
}
}
],
"products": [
{
"id": "PRODUCT_A",
"idProductFamily": "DEFAUT"
},
{
"id": "PRODUCT_B",
"idProductFamily": "DEFAUT"
}
],
"logisticProfiles": [
{
"id": "PROFILE_L01",
"maxAllowedSize": 99,
"fixedTimeSite": 0,
"fixedTimeOperation": 120,
"positionOnRoute": "UNCONSTRAINED",
"maxAllowedWeight": 99999
},
{
"id": "PROFILE_L02",
"maxAllowedSize": 99,
"fixedTimeSite": 0,
"fixedTimeOperation": 120,
"positionOnRoute": "UNCONSTRAINED",
"requiredCharacteristics": [
"5000 L"
],
"maxAllowedWeight": 99999
}
],
"legislationProfiles": [
{
"id": "DEFAUT",
"waitingIsWorking": true,
"drivingPauseDurationCuts": [
108000,
54000
]
}
]
}