Update, cancel or move a load
Once a load is added to an equipment and is planned, it is possible to modify the status of the load. An equipment operator can Update the load, Cancel the load or Move the load to another equipment or another compartment.
Cancel a planned load
PUT {eecdapi}/equipment/{equipmentId}/loads/{loadId}/cancel
Usage
Cancels a load, if it is still planned.
Information
The load will contain a log entry to indicate it being cancelled. This will be visible in the booklet
Query string parameters
Equipment ID
Load ID
Response (expand to open)
Cancel load
{
"id": "string",
"lastStatusDate": "2019-12-05T13:08:56.069Z",
"isAcceptedByPaper": true,
"status": "CANCELLED",
"product": {
"productId": "string",
"sellerId": "string",
"sellerName": "string",
"productType": "CHEMICAL",
"articleNumber": "string",
"articleName": "string",
"unNr": "string"
},
"loadDetails": {
"loadPlannedAt": "2019-12-05T13:08:56.069Z",
"loaderId": "string",
"loaderName": "string",
"loadingLocation": "string",
"transportOrderId": "string"
},
"references": {
"customerReference": "string",
"internalReference": "string"
},
"compartments": [
"string"
],
"processStates": [
{
"status": "PLANNED",
"fullName": "string",
"userId": "string",
"timeStamp": "2019-12-05T13:08:56.069Z",
"comment": "string"
}
],
"attachments": [
{
"id": "string",
"originalFilename": "string"
}
]
}
Update a planned load
PUT {eecdapi}/equipment/{equipmentId}/loads/{loadId}
Usage
Updates a load, if the loader hasn't already accepted or rejected it.
Information
The validation rules apply as if it would be created
The load will contain a log entry to indicate it being updated.
Query string parameters
Equipment ID
Load ID
Body
Update a planned load
{
"productId": "string",
"sellerId": "string",
"loadDetails": {
"loadPlannedAt": "2019-12-05T13:34:45.799Z",
"loaderId": "string",
"loaderName": "string",
"loadingLocation": "string",
"transportOrderId": "string"
},
"references": {
"customerReference": "string",
"internalReference": "string"
},
"compartments": [
"string"
]
}
Response (expand to open)
Update planned load
{
"id": "string",
"lastStatusDate": "2019-12-05T13:37:08.503Z",
"isAcceptedByPaper": true,
"status": "PLANNED",
"product": {
"productId": "string",
"sellerId": "string",
"sellerName": "string",
"productType": "CHEMICAL",
"articleNumber": "string",
"articleName": "string",
"unNr": "string"
},
"loadDetails": {
"loadPlannedAt": "2019-12-05T13:37:08.503Z",
"loaderId": "string",
"loaderName": "string",
"loadingLocation": "string",
"transportOrderId": "string"
},
"references": {
"customerReference": "string",
"internalReference": "string"
},
"compartments": [
"string"
],
"processStates": [
{
"status": "PLANNED",
"fullName": "string",
"userId": "string",
"timeStamp": "2019-12-05T13:37:08.503Z",
"comment": "string"
}
],
"attachments": [
{
"id": "string",
"originalFilename": "string"
}
]
}
Move a planned load
PUT {eecdapi}/equipment/{equipmentId}/loads/{loadId}/move
Usage
Move a load from one equipment to another
Information
Both equipments must be owned by the operator, and the receiving equipment may not yet have any planned loads for any of the compartments of the moved load.
The load will contain a log entry to indicate it being moved.
Query string parameters
Equipment ID
Load ID
Body
Move a planned load
{
"targetEquipmentId": "string",
"comment": "string"
}
Response
Move planned load
{
"id": "string",
"lastStatusDate": "2019-12-05T13:38:55.825Z",
"isAcceptedByPaper": true,
"status": "PLANNED",
"product": {
"productId": "string",
"sellerId": "string",
"sellerName": "string",
"productType": "CHEMICAL",
"articleNumber": "string",
"articleName": "string",
"unNr": "string"
},
"loadDetails": {
"loadPlannedAt": "2019-12-05T13:38:55.825Z",
"loaderId": "string",
"loaderName": "string",
"loadingLocation": "string",
"transportOrderId": "string"
},
"references": {
"customerReference": "string",
"internalReference": "string"
},
"compartments": [
"string"
],
"processStates": [
{
"status": "PLANNED",
"fullName": "string",
"userId": "string",
"timeStamp": "2019-12-05T13:38:55.825Z",
"comment": "string"
}
],
"attachments": [
{
"id": "string",
"originalFilename": "string"
}
]
}