Introduction
Cleaners are able to create one-time equipment booklet when they cannot search for Equipment Operator in the system.
Once one-time booklet is created, a cleaning request is also created with “PLANNED” status. Cleaners can then continue cleaning process with this one-time equipment such as update / cancel / cleaner sign off/ driver sign off /invalidate cleaning like normal equipment.
Create one time booklet / one time equipment
A cleaner can create one time equipment together with the cleaning action they are going to perform.
POST {eecdAPI}/one-time-booklet
Request body parameters
|
Property |
Type |
Example |
Notes |
|
licensePlate |
String |
XWAFC |
Follows normal equipment creation |
|
internalEquipmentCode |
String |
Equipment-1234 |
|
|
licensePlateCountry |
String |
FR |
|
|
containerId |
String |
WAVSW |
|
|
equipmentType |
Integer |
TANKCONTAINER = 1, TANKTRAILER = 2, IBC = 3, RAILTANK = 4 |
|
|
productType |
Integer |
Chemical=0 Food=1 Feed=2 Pharma=3 |
|
|
compartmentsWithLoad |
Array |
|
Array of compartments with load information |
|
carrierName |
String |
Transport company 1 |
|
|
carrierAddress |
String |
Belgium |
|
|
carrierContactDetail |
String |
+84 123 123, Antwerp |
|
|
compartmentsWithLoad. productName |
String |
LUPRANOL 1234 |
|
|
compartmentsWithLoad. unNr |
String |
0314 |
|
|
type |
String |
STANDARD, POLYMER |
The type of cleaning |
|
locationId |
Guid |
08d5fc53-8cfa-b6ae-7356-ab97bfe08a40 |
Guid of cleaning location inside the system |
|
isUnaccompanied |
Boolean |
false |
|
Body example
{
"equipmentType": "TANKCONTAINER",
"licensePlate": "string",
"internalEquipmentCode": "string",
"containerId": "string",
"licensePlateCountry": "string",
"carrierName": "string",
"carrierAddress": "string",
"carrierContactDetail": "string",
"productType": "CHEMICAL",
"compartmentsWithLoad": [
{
"productName": "string",
"unNr": "string"
}
],
"locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "STANDARD",
"isUnaccompanied": true
}
The response format is the same with existing API to get the equipment’s booklet.
{eecdAPI}/equipment/{equipmentId}/history
Create and accept load for one time booklet as loader
Being able to find a one-time booklet from cleaning short code, loader can create and accept a load
POST {eecdAPI}/one-time-booklet/{oneTimeEquipmentId}/loads/accept
Request body parameters
|
Property |
Type |
Example |
Notes |
|
productName |
String |
LUPRANOL 2433 |
|
|
comment |
String |
Fully loaded |
|
|
transportOrderReference |
String |
REF-12345 |
|
Request body example
{
"transportOrderReference": "string",
"productName": "string",
"comment": "string"
}
API response follows normal load assignment.
{eecdAPI}/equipment/{equipmentId}/loads/assign
Create and reject load for one time booklet as loader
Being able to find a one-time booklet from cleaning short code, loader can create and reject a load.
POST {eecdAPI}/one-time-booklet/{oneTimeEquipmentId}/loads/reject
The request body format is the same with section 14 – accept load. With comments being mandatory for rejection
API response follows normal load rejection.
PUT {eecdAPI}/equipment/{equipmentId}/loads/{loadId}/reject