5.9 Solution Error Objects
A solution error object describes a constraint that has been violated by the assignments. Unlike error strings, this representation allows client systems to present solution errors in their preferred way.
All solution error objects contain a field named code. The value of this field is one of the solution error codes. It distinguishes different types of solution error from one another. Each kind of solution error object contains additional fields that are specific to the type of error they describe.
5.9.1 Solution Error Codes
These describe the type of solution error object. The possible values are:
- COMPARTMENT_CAPACITY_EXCEEDED
- AXLE_WEIGHT_LIMIT_EXCEEDED
- GCM_LIMIT_EXCEEDED
- COMPARTMENT_FILL_BELOW_ORDER_MINIMUM
- COMPARTMENT_SAFE_FILL_EXCEEDED
- ORDER_MAXIMUM_VOLUME_EXCEEDED
- FIRST_COMPARTMENT_FILL_INSUFFICIENT
- FIRST_COMPARTMENT_EMPTY
- REQUIRED_ORDER_NOT_ASSIGNED
- LARGE_COMPARTMENT_ULLAGE_VIOLATION
- FORBIDDEN_COMPARTMENT_FOR_ORDER
- FILL_BELOW_MINIMUM_FILL_LEVEL
- FILL_EXCEEDS_MAXIMUM_FILL_LEVEL
5.9.2 CompartmentCapacityExceeded Solution Error Object
A CompartmentCapacityExceeded solution error object describes the situation when the volume of product assigned to a compartment exceeds the maximum volume of the compartment. It has the following additional fields:
- order: the identifier of the order assigned to the compartment.
- compartment: the identifier of the compartment.
- capacity: the maximum volume the compartment can hold.
- assigned_volume: the volume assigned to the compartment.
Here is an example CompartmentCapacityExceeded solution error object:
{
"code": "COMPARTMENT_CAPACITY_EXCEEDED",
"order": "ORDER1",
"compartment": "C3",
"capacity": 1100,
"assigned_volume": 1250
}
5.9.3 AxleWeightLimitExceeded Solution Error Object
An AxleWeightLimitExceeded solution error object describes the situation where the weight over an axle group exceeds the weight limit for the axle group at a given site. It has the following additional fields:
- axle_group: the axle group identifier.
- site: the site identifier.
- weight: the weight over the axle group.
- limit: the weight limit for the axle group at the site.
Here is an example AxleWeightLimitExceeded solution error object:
{
"code": "AXLE_WEIGHT_LIMIT_EXCEEDED",
"axle_group": "AG2",
"site": "SITE2",
"weight": 1500,
"limit": 1400
}
5.9.4 GcmLimitExceeded Solution Error Object
A GcmLimitExceeded solution error object describes the situation where the GCM of a vehicle exceeds the GCM limit at a given site. It has the following additional fields:
- site: the identifier of the site.
- limit: the GCM limit at the site.
- gcm: the GCM at the site.
Here is an example GcmLimitExceeded solution error object:
{
"code": "GCM_LIMIT_EXCEEDED",
"site": "SITE3",
"limit": 13000,
"gcm": 14500
}
5.9.5 CompartmentFillBelowOrderMinimum Solution Error Object
A CompartmentFillBelowOrderMinimum solution error object describes the situation where the volume of an order assigned to a compartment is less than the minimum compartment volume for that order. It has the following additional fields:
- compartment: the identifier of the compartment.
- order: the identifier of the order.
- minimum_volume: the minimum compartment volume for the order.
- assigned_volume: the volume of the order assigned to this compartment.
Here is an example CompartmentFillBelowOrderMinimum solution error object:
{
"code": "COMPARTMENT_FILL_BELOW_ORDER_MINIMUM",
"compartment": "C1",
"order": "ORDER2",
"minimum_volume": 1000,
"assigned_volume": 10
}
5.9.6 CompartmentSafeFillExceeded Solution Error Object
A CompartmentSafeFillExceeded solution error object describes the situation where a compartment has been filled beyond its safe fill level. It has the following additional fields:
- order: the identifier of the order assigned to the compartment.
- compartment: the identifier of the compartment.
- safe_fill_level: the safe fill level of the compartment.
- assigned_volume: the volume assigned to compartment.
Here is an example CompartmentSafeFillExceeded solution error object:
{
"code": "COMPARTMENT_SAFE_FILL_EXCEEDED",
"order": "ORDER4",
"compartment": "C5",
"safe_fill_level": 700,
"assigned_volume": 900
}
5.9.7 OrderMaximumVolumeExceeded Solution Error Object
A OrderMaximumVolumeExceeded solution error object describes the situation where the total volume of an order assigned to the vehicle exceeds the maximum volume for that order. It has the following additional fields:
- order: the identifier of the order.
- site: the identifier of the delivery site for the order.
- maximum_volume: the maximum volume that can be delivered for this order.
- assigned_volume: the volume of the order assigned to this vehicle.
Here is an example OrderMaximumVolumeExceeded solution error object:
{
"code": "ORDER_MAXIMUM_VOLUME_EXCEEDED",
"order": "ORDER4",
"site": "SITE2",
"maximum_volume": 6000,
"assigned_volume": 8000
}
5.9.8 FirstCompartmentFillInsufficient Solution Error Object
A FirstCompartmentFillInsufficient solution error object describes the situation where the load in the first compartment is not sufficient to satisfy the vehicle stability constraints. It has the following additional fields:
- order: the identifier of the order assigned to the first compartment.
- site: the identifier of the site where the first compartment is not sufficiently loaded.
- first_compartment: the identifier of the first compartment.
- minimum_volume: the volume that must be assigned to the first compartment to satisfy the stability constraints.
- assigned_volume: the volume that is assigned to the first compartment.
Here is an example FirstCompartmentFillInsufficient solution error object:
{
"code": "FIRST_COMPARTMENT_FILL_INSUFFICIENT",
"order": "ORDER3",
"site": "SITE1",
"first_compartment": "C1",
"minimum_volume": 8340,
"assigned_volume": 40
},
5.9.9 FirstCompartmentEmpty Solution Error Object
A FirstCompartmentEmpty solution error object describes the situation where the first compartment needs to be filled to ensure vehicle stability, but it is empty. It has the following additional fields:
- site: the identifier of the site where the first compartment is empty.
- first_compartment: the identifier of the first compartment.
- non_empty_compartments: an array of compartment identifiers that are non-empty at the given site.
Here is an example FirstCompartmentEmpty solution error object:
{
"code": "FIRST_COMPARTMENT_EMPTY",
"site": "SITE2",
"first_compartment": "C1",
"non_empty_compartments": [
"C2", "C3"
]
}
5.9.10 BookendCompartmentFillInsufficient Solution Error Object
A BookendCompartmentFillInsufficient solution error object describes the situation where the load in one of the bookend compartments is not sufficient to satisfy the vehicle stability constraints. It has the following additional fields:
- order: the identifier of the order assigned to the bookend compartment.
- site: the identifier of the site where the bookend compartment is not sufficiently loaded.
- compartment: the identifier of the bookend compartment.
- minimum_volume: the volume that must be assigned to the bookend compartment to satisfy the stability constraints.
- assigned_volume: the volume that is assigned to the bookend compartment.
Here is an example BookendCompartmentFillInsufficient solution error object:
{
"code": "BOOKEND_COMPARTMENT_FILL_INSUFFICIENT",
"order": "ORDER3",
"site": "SITE1",
"compartment": "C1",
"minimum_volume": 8340,
"assigned_volume": 40
},
5.9.11 BookendCompartmentEmpty Solution Error Object
A BookendCompartmentEmpty solution error object describes the situation where at least one bookend compartment needs to be filled to ensure vehicle stability, but they are all empty. It has the following additional fields:
- site: the identifier of the site where the compartment is empty.
- compartments: the identifiers of the compartments.
- non_empty_compartments: an array of compartment identifiers that are non-empty at the given site.
Here is an example BookendCompartmentEmpty solution error object:
{
"code": "BOOKEND_COMPARTMENT_EMPTY",
"site": "SITE2",
"compartments": ["C1"],
"non_empty_compartments": [
"C2", "C3"
]
}
5.9.12 RequiredOrderNotAssigned Solution Error Object
A RequiredOrderNotAssigned solution error object describes the situation where an order is required to be assigned, but it is not. It has the following additional field:
- order: the identifier of the order that is not assigned.
Here is an example RequiredOrderNotAssigned solution error object:
{
"code": "REQUIRED_ORDER_NOT_ASSIGNED",
"order": "ORDER4"
}
5.9.13 LargeCompartmentUllageViolation Solution Error Object
A LargeCompartmentUllageViolation solution error object describes the situation where the ullage restrictions on a large compartment have not been satisfied. It has the following additional fields:
- order: the identifier of the order assigned to the compartment.
- compartment: the identifier of the compartment that does not satisfy the ullage restrictions.
- assigned_volume: the volume assigned to the compartment.
Here is an example LargeCompartmentUllageViolation solution error object:
{
"code": "LARGE_COMPARTMENT_ULLAGE_VIOLATION",
"order": "ORDER3",
"compartment": "C2",
"assigned_volume": 6400
}
5.9.14 ForbiddenCompartmentForOrder Solution Error Object
A ForbiddenCompartmentForOrder solution error object describes the situation where the forbidden compartment constraint has been violated. It has the following additional fields:
- compartment: the identifier of the compartment that does not satisfy the forbidden compartment constraint.
- order: the identifier of the order that is assigned to the compartment.
Here is an example ForbiddenCompartmentForOrder solution error object:
{
"code": "FORBIDDEN_COMPARTMENT_FOR_ORDER",
"compartment": "C1",
"order": "ORDER_4"
}
5.9.15 FillBelowMinimumFillLevel Solution Error Object
A FillBelowMinimumFillLevel solution error object describes the situation where the quantity of an order assigned to a compartment is below the level required by an additional fill level limit for that order and compartment. It has the following additional fields:
- order: the identifier of the order that is assigned to the compartment and is the subject of the fill level limit.
- compartment: the identifier of the compartment.
- assigned_volume: the volume that is assigned to the compartment.
- minimum_fill_level: the minimum fill required for the order and compartment by the additional fill level limit.
Here is an example FillBelowMinimumFillLevel solution error object:
{
"code": "FILL_BELOW_MINIMUM_FILL_LEVEL",
"order": "ORDER_4",
"compartment": "C3",
"assigned_volume": 2000,
"minimum_fill_level": 6000
}
5.9.16 FillExceedsMaximumFillLevel Solution Error Object
A FillExceedsMaximumFillLevel solution error object describes the situation where the quantity of an order assigned to a compartment exceeds the level required by an additional fill level limit for that order and compartment. It has the following additional fields:
- order: the identifier of the order that is assigned to the compartment and is the subject of the fill level limit.
- compartment: the identifier of the compartment.
- assigned_volume: the volume that is assigned to the compartment.
- maximum_fill_level: the maximum fill required for the order and compartment by the additional fill level limit.
Here is an example FillExceedsMaximumFillLevel solution error object:
{
"code": "FILL_EXCEEDS_MAXIMUM_FILL_LEVEL",
"order": "ORDER_2",
"compartment": "C1",
"assigned_volume": 7200,
"maximum_fill_level": 6000
}
