Non Registered Loads

Not every load and cleaning action is necessarily processed through the NxtPort / Eecd API. However, in order to be keep track of previous loads that are not available in the history, an equipment operator can add a "non-registered" load.

Add a non registered load

POST {eecdapi}/equipment/{equipmentId}/loads/addnonregistered

Usage

• Allows an equipment operator to add a load that was not processed through the Eecd API

Information

• The non-registered load is far less detailed than normal loads, and needs to be accompanied by proof justifying the need for an non-registered load.

• Please refer to Upload Attachments for adding documents to proof the non-registered load.

Body

Add non registered load

{
  "productName": "string",
  "loadDate": "2019-12-05T14:00:08.132Z",
  "compartments": [
    "string"
  ],
  "comment": "string",
  "unNumber": "string"
}

Response

Add non registered load response

{
  "id": "string",
  "lastStatusDate": "2019-12-05T14:23:58.867Z",
  "isAcceptedByPaper": true,
  "status": "NONREGISTERED",
  "product": {
    "productId": "string",
    "sellerId": "string",
    "sellerName": "string",
    "productType": "CHEMICAL",
    "articleNumber": "string",
    "articleName": "string",
    "unNr": "string"
  },
  "loadDetails": {
    "loadPlannedAt": "2019-12-05T14:23:58.867Z",
    "loaderId": "string",
    "loaderName": "string",
    "loadingLocation": "string",
    "transportOrderId": "string"
  },
  "references": {
    "customerReference": "string",
    "internalReference": "string"
  },
  "compartments": [
    "string"
  ],
  "processStates": [
    {
      "status": "NONREGISTERED",
      "fullName": "string",
      "userId": "string",
      "timeStamp": "2019-12-05T14:23:58.867Z",
      "comment": "string"
    }
  ],
  "attachments": [
    {
      "id": "string",
      "originalFilename": "string"
    }
  ]
}

Remark

In the booklet, a non registered load will be displayed as a normal load with a status NONREGISTERED

Proof non registered load

POST {eecdapi}/equipment/{equipmentId}/loads/{loadId}/attachments

Usage

• Add attachment to proof non registered load

Information

• A non-registered load on its own has very little meaning; it needs to be accompanied by one or more documents that serve as proof. They can be uploaded using this call.

• equipmentId: mandatory information to store the load to the relevant equiment

• loadId: mandatory parameter to link the attachment to the load. Uploading documents can't be done in the same action when creating the non-registered load. 

Body

• Upload the file using form data, with key "file" and as value the file to be stored.

File

• The file to be stored. We currently support the following file formats: gif, jpg, png, bmp, pdf, txt, docx

Response

• The non-registered load in the same format as the response of the call for adding a non-registered load, with the uploaded attachment added to the list of attachments. The ID of the attachment can be used to download it in the next call.

Download proof of non-registered load

GET {eecdapi}/equipment/{equipmentId}/loads/{loadId}/attachments/{attachmentId}

Usage

• Get an attachment that proofs an unregistered load

Information

• The file will be downloaded directly upon following the link.

Query parameters

• EquipmentID: The ID of the equipment 

• LoadId: the ID of the load

• DocumentIt: The id of the attachmant

All query parameters can be found by opening the booklet of the equipment