Skip to main content

Route Profiles

Route Profile​

This object describes a route profile. See RouteProfile definition under Schemas/RouteProfile in MPT OpenAPI Documentation.

Example of Route Profile
{
	"organization": "TEST",
	"name": "EXAMPLE",
	"description": "Example of Route Profile",
	"language": "FR",
	"calculationParameters": [
		{
			"code": "460",
			"value": "180",
			"relaxedValue": "999999"
		}
	],
	"functionalities": {
		"zoning": "ENTIRE_CONTROL",
		"operationPriorities": "ASCENDING_ORDER"
	},
	"valorizations": {
		"solution": [
			{
				"criteria": [
					"DISTANCE",
					"DRIVING_TIME"
				]
			}
		],
		"timeSchedule": [],
		"unfeasibleTimeSchedule": [],
		"unfeasibleSequencing": [],
		"affectationOperationDepot": []
	},
	"unitOfCompartments": "VOLUME",
	"unitOfDepotAssignmentScopeQuantities": "VOLUME",
	"distancePrecision": "METER",
	"timePrecision": "MINUTE",
	"nightDefinition": {
		"startTime": "18:00",
		"endTime": "06:00:00",
		"timeZone": "Europe/Paris"
	}
}
Info

calculationParameters property is a list of calculation parameter

Info

functionalities property is a list of logistic functionalities

Info

valorizations property describe the valorizations

Info

nightDefinition property define the night

Calculation Parameter​

This object describes a calculation parameter.
See CalculationParameter definition under Schemas/CalculationParameter in MPT OpenAPI Documentation.

Example of Calcualtion Parameter
{
	"code": "460",
	"value": "180",
	"relaxedValue"; "999999"
}

Logistic Functionalities​

This object describes a calculation parameter.
See Functionalities definition under Schemas/Functionalities in MPT OpenAPI Documentation.

Example of Logistic Functionalities
{
	"zoning": "ENTIRE_CONTROL",
	"operationPriorities": "ASCENDING_ORDER"
}

Valorizations​

This object describes how to valorize a solution.
See Valorizations definition under Schemas/Valorizations in MPT OpenAPI Documentation.

Example of Valorizations
{
	"solution": [
		{
			"criteria": [
				"DISTANCE",
				"DRIVING_TIME"
			]
		}
	],
	"timeSchedule": [],
	"unfeasibleTimeSchedule": [],
	"unfeasibleSequencing": [],
	"affectationOperationDepot": []
}
Info

solution, timeSchedule, unfeasibleTimeSchedule, unfeasibleSequencing, affectationOperationDepot properties are lists of valorisation component

Valorization Component​

This object describe a valorization compoment.
See ValorizationComponent definition under Schemas/ValorizationComponent in MPT OpenAPI Documentation.

Example of Valorization Component
{
	"criteria": ["DISTANCE","DRIVING_TIME"]
}

Night Definition​

This object define what i a night See NightDefinition definition under Schemas/NightDefinition in MPT OpenAPI Documentation.

Example of Night Definition
{
	"startTime": "18:00",
	"endTime": "06:00:00",
	"timeZone": "Europe/Paris"
}
Warning

startTime and endTime properties must comply with format hh:mm or hh:mm:ss

  • hh is a value between 00 and 23
  • mm and ss are values between 00 and 59