Kardinal Resource API is one of 8 APIs that Kardinal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Resource. 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
6 operations
across 3 paths,
and defines 81 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.
Duration
string
A period of time, expressed in the ISO8601 duration format.
EnvelopedErrors
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
1 property
AdditionalConstraintCapacities
object
This constraint is valid if all the capacities are satisfied.
4 properties
3 required
AdditionalConstraintMaxStopTagGroups
object
If the tour has stops whose stopTags constitute too many groups, then the tour is invalid.
4 properties
2 required
RegexIdValidation
string
At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "", "~", ":", "@", "!", "$", ",".
Properties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
PlanObjectives
array
[TOVALIDATE] Description pending review by a Kardinal engineer.
AdditionalConstraintAtLeastOneConstraint
object
If one of the constraint is valid, then the tour is valid.
3 properties
2 required
TimeWindow
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties
2 required
AlternativesStop
object
A stop composed of different alternative single stops.
3 properties
2 required
IncompatibleStopTags
array
Incompatibilities between stop tags (all elements must be different regardless of order).
PlanStatus
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
5 properties
Plan
object
A plan for a date and agency, with resource and orders associated.
33 properties
3 required
MaximizePrecedencesObjective
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
2 required
StopTagPrecedencePair
object
A pair of precedence stop tags.
2 properties
2 required
CostsByResourceTag
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
SetupDuration
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
3 required
StopKind
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
MaxInterStopDurationBounds
object
Per-segment maximum duration between two consecutive stops on a tour. Each key is independent; an absent key means no constraint on that segment.
3 properties
PlanState
string
The corresponding plan's state. - waiting: The plan was received and is awaiting processing. - processing: The plan is being processed. - preOptimizing: The pl…
Position
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties
2 required
CountryCode
string
A country standard name or Alpha-2 code or Alpha-3 code.
VehicleProfileBicycle
object
A cyclist profile. Unaffected by traffic variations.
6 properties
1 required
CostFloorsAndCoeffs
object
Cost floors and coefficients. A cost cannot be empty. An overcost cannot be set if there is no cost, and the overcostFloor must be greater than costFloor.
5 properties
VehicleProfileMotorbike
object
A motorized profile for vehicles over 125cc, unrestricted in terms of roads. Unaffected by traffic variations.
9 properties
1 required
MaxInterStopDistanceInKmBounds
object
Per-segment maximum distance, in km, between two consecutive stops on a tour. Each key is independent; an absent key means no constraint on that segment.
3 properties
TimeWindowBreak
object
A required break of a given duration in a given time window.
3 properties
2 required
StopTagPair
array
A pair of incompatible stop tags.
AdditionalConstraintAtLeastOneValidCapacity
object
If the tour has not, at each stop, one of its capacities lower than or equal to the link limit, then the tour is invalid.
4 properties
2 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
PlanStatusVersion
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties
AvoidEarlyLoading
object
Declares a stop tag and optional capacities for early loading computation.
2 properties
1 required
Order
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
8 properties
2 required
AdditionalConstraintForbiddenAssignment
object
Forbidden assignment by stop tag and resource tag.
4 properties
3 required
RemovalStrategyType
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
TaggedTimeWindow
object
TimeWindow with resource tags.
3 properties
2 required
GlobalConstraintMaxCumulatedCost
object
Provide an upper bound on the cost of specified resources.
4 properties
2 required
OptimizationDirection
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
EnvelopedResource
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
AdditionalConstraintRemovalStrategy
object
If the tour does not respect the defined removal strategy, then the tour is invalid.
5 properties
1 required
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
ForbiddenAssignment
object
Forbidden assignment by stop tag and resource tag.
2 properties
2 required
ErrorProperties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
AssignmentBegin
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
2 required
VehicleProfileCar
object
A light-weight vehicle profile. Affected by traffic variations.
12 properties
1 required
AssignmentEnd
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
2 required
TunnelCategory
string
Tunnel category restriction for truck routing (ADR tunnel categories)
EnvelopedPlan
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
Break
[TOVALIDATE] Description pending review by a Kardinal engineer.
SingleStop
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
10 properties
2 required
AtFirstPositionArrival
string
The resource must go back to it's Tour first position.
VehicleProfilePedestrian
object
A walking "driver" profile. Pedestrians are unaffected by traffic variations.
5 properties
1 required
DateTime
string
A full calendar date time, expressed in the ISO8601 date format: YYYY-MM-DDThh:mm:ssZ.
CustomObjective
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
4 required
WorkingDurationSlidingBreak
object
Limitation rule on max working duration without any break.
3 properties
3 required
AssignmentStop
object
The beginTime is set to arrivalTime if not setted. If the stopId is the id of an alternative, arrivalTime, beginTime, and departureTime cannot be set and the c…
6 properties
1 required
AssignmentBreak
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
3 required
State
object
[TOVALIDATE] Believed to describe a resource's manual-mode state. Needs confirmation.
2 properties
ResourceMode
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
Capacities
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
MaxGroupsByStopTag
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
EnvelopedState
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
ObjectivesEnum
string
The available optimization objectives, processed lexicographically in the order provided in Plan.objectives: - maximizeMandatoryStops: Maximizes the number of…
Resource
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
23 properties
3 required
AdditionalOperationDuration
object
Additional operation duration by stop tag and resource tag.
3 properties
3 required
RegexPrefixedIdValidation
string
An id beginning with a prefix and an underscore.
ShippedHazardousGood
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
AssignmentStatus
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
OperationDurationPolicy
object
Policy to indicate which operation duration must not be taken into account.
2 properties
1 required
TravelDurationSlidingBreak
object
Limitation rule on max travel duration without any break.
3 properties
3 required
PlanVersion
integer
The plan version.
TimeZone
string
The time zone is a string code which identifies a region of the world in the "time zone database", also called "tz database". The tz database is a partition of…
Cost
object
A composable cost model used by the minimizeCosts objective — every field set on this object (workedHours, km, using, and the per-stop-tag / per-capacity / per…
7 properties
Stop
[TOVALIDATE] Description pending review by a Kardinal engineer.
AdditionalConstraintIncompatibleStopTags
object
Incompatibility between stop tags.
4 properties
2 required
Error
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties
2 required
TaggedCostFloorsAndCoeffs
object
1 property
VehicleProfileFly
object
A crow-fly (straight-line) mode of transportation, useful for quick testing since it is computed extremely fast.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kardinal publishes across the network.
