Kardinal Solution API is one of 8 APIs that Kardinal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Solution. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
2 operations
across 2 paths,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 2.55.0.
Requests are made against a single base URL, /api/v2.
The identity and technical contract details declared by the specification.
Solution
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
13 properties
WayPointStatus
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
WayPointBegin
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
6 properties
2 required
OptimizationDirection
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
EnvelopedSolutionObjectives
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
Capacities
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
TourViolation
Semantic violations, can be handled "generically" or specifically.
VehicleProfileScooter
object
A 50cc to 125cc motorized profile, with limited access to certain highways and high-speed roads. Unaffected by traffic variations.
8 properties
1 required
FromPrevious
object
The travel distance and duration from the previous waypoint to the current one.
2 properties
2 required
MaxInterStopDistanceInKmViolation
object
Violation of a resource's MaxInterStopDistanceInKm constraint.
4 properties
3 required
ErrorProperties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
ForbiddenAssignment
object
Forbidden assignment by stop tag and resource tag.
2 properties
2 required
WorkingTimeWindowViolation
object
Violation of a resource's TimeWindow constraint.
2 properties
2 required
MaxWorkingDurationViolation
object
Violation of a resource's MaxWorkingDuration constraint.
3 properties
3 required
OrderViolation
object
Violation of a order's stops constraint.
4 properties
2 required
StopKind
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
MaxInterStopDurationViolation
object
Violation of a resource's MaxInterStopDuration constraint.
4 properties
3 required
WayPointEnd
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
6 properties
2 required
TunnelCategory
string
Tunnel category restriction for truck routing (ADR tunnel categories)
Duration
string
A period of time, expressed in the ISO8601 duration format.
CountryCode
string
A country standard name or Alpha-2 code or Alpha-3 code.
BeginViolation
object
Violation of a warehouse Constraint at the begining of a Tour.
2 properties
1 required
EnvelopedErrors
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
1 property
Position
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties
2 required
RegexPrefixedIdValidation
string
An id beginning with a prefix and an underscore.
ResourceMode
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
VehicleProfileBicycle
object
A cyclist profile. Unaffected by traffic variations.
6 properties
1 required
WayPointBreak
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
6 properties
1 required
ShippedHazardousGood
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
EndViolation
object
Violation of a warehouse Constraint at the end of a Tour.
2 properties
1 required
SuccessiveStopsViolation
object
Violation of a order's succesive stops constraint.
3 properties
2 required
VehicleProfileMotorbike
object
A motorized profile for vehicles over 125cc, unrestricted in terms of roads. Unaffected by traffic variations.
9 properties
1 required
WaypointViolation
Semantic violations, can be handled "generically" or specifically.
PlanVersion
integer
The plan version.
AtLeastOneConstraintViolation
object
Violation of a resource's AtLeastOneConstraint constraint.
3 properties
3 required
StopTagPair
array
A pair of incompatible stop tags.
MaxDistanceInKmViolation
object
Violation of a resource's MaxDistanceInKm constraint.
3 properties
3 required
EnvelopedSolution
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
RemovalStrategyViolation
object
Violation of a resource's RemovalStrategy constraint.
3 properties
2 required
VehicleProfileCar
object
A light-weight vehicle profile. Affected by traffic variations.
12 properties
1 required
VehicleProfilePedestrian
object
A walking "driver" profile. Pedestrians are unaffected by traffic variations.
5 properties
1 required
GlobalViolationMaxCumulatedCost
object
Violation linked to a MaxCumulatedCost global constraint.
5 properties
DateTime
string
A full calendar date time, expressed in the ISO8601 date format: YYYY-MM-DDThh:mm:ssZ.
AuthorizedTimeWindowViolation
object
Violation of a stop's TimeWindow constraint.
4 properties
3 required
VehicleProfileTruck
object
A heavy-weight vehicle profile. Affected by both traffic variations and road restrictions (weight, height, hazardous goods, etc.).
18 properties
1 required
StopIncompatibilityViolation
object
Violation of a resource's StopIncompatibility constraint.
4 properties
3 required
RegexIdValidation
string
At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "", "~", ":", "@", "!", "$", ",".
ForbiddenAssignmentViolation
object
Violation of a ForbiddenAssignment constraint.
3 properties
1 required
CapacityViolation
object
Violation of a resource's capacity constraint.
4 properties
3 required
MaxStopTagGroupsViolation
object
Violation of a resource's MaxStopTagGroups constraint.
3 properties
2 required
Properties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
AtLeastOneValidCapacityViolation
object
Violation of a AtLeastOneValidCapacity constraint.
4 properties
3 required
Error
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
2 required
RemovalStrategyType
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
Tour
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
18 properties
SkillsViolation
object
Violation of a Skill constraint.
3 properties
1 required
WayPointStop
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
14 properties
2 required
ExceededNbGroups
object
The maximum number of groups and its corresponding exceeding number of groups, for a stop tag.
2 properties
2 required
SolutionObjective
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
VehicleProfileFly
object
A crow-fly (straight-line) mode of transportation, useful for quick testing since it is computed extremely fast.
2 properties
1 required
TimeWindow
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties
2 required
MaxStopSpanViolation
object
Violation of a order's MaxStopSpan constraint.
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kardinal publishes across the network.
