/assign

ASSIGN a release to a driver or barge.

This request allows you to assign a release to a driver or barge.

This will be used by the terminal to validate the identity of the driver when he presents himself at the gate, or in the case of a barge when the pre-announcement (copino load) is received.

Please note that to update an assignment, you can just do a new call to the endpoints below. You do not need to unassign first.

---

ASSIGN (driver)

The API will create and update drivers in the web application automatically.

So any driver you assign using the API can also be seen in the web application and used to assign to a release.

When the data in your API call is different from the last time this driver was assigned, the data in the web application will be updated too.

The key to uniquely identify a driver is the identification number.

Assign a release

put

https://url:port/tmining/api/v1https://test-admin.securecontainerrelease.com:4430/legacy/tmining/api/v1

/releases/{address}/assign

Assign a release to a driver, barge, or train.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Body

application/json

firstNamestringOptional

lastNamestringOptional

emailstringOptional

phonestringOptional

typestring · enumOptionalPossible values:

identificationstringOptional

Responses

204

Request accepted

401

Invalid Authorization bearer token

403

Access forbidden

404

Release not found

500

Internal server error

put

/releases/{address}/assign

HTTPcURLJavaScriptPython

PUT /tmining/api/v1/releases/{address}/assign HTTP/1.1
Host: url:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "phone": "text",
  "type": "driver",
  "identification": "text"
}

No content

EXAMPLE

ASSIGN a driver to a release (without type in URL):

server = https://url:port/tmining/api/v1

ASSIGN a driver to a release (with type in URL):

server = https://url:port/tmining/api/v1

---

ASSIGN (barge)

For barges, the identification is the ENI-number of the barge and the visit number, which is the BTS number in Antwerp.

Therefore, for barges these fields are foreseen:

• name: the name of the barge (mandatory)

• identification: the ENI number of the barge (mandatory)

• visitNumber: the visit number of the barge (optional)

Please note that the visit number (BTS number) is not mandatory.

However, the terminal will check this at the moment the loading order (copino) is received.

So by that time, the visit number has to be included in SCR.

Otherwise, the check of the terminal will fail.

Assign a barge to a release

put

https://url:port/tmining/api/v1https://test-admin.securecontainerrelease.com:4430/legacy/tmining/api/v1

/releases/{address}/assign_barge

Assign a barge with identification and visit number.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Body

application/json

namestringRequired

The name of the barge

identificationstringRequired

The ENI number of the barge

visitNumberstringOptional

The visit number (BTS number) of the barge

Responses

204

Request accepted

401

Invalid Authorization bearer token

403

Access forbidden

404

Release not found

500

Internal server error

put

/releases/{address}/assign_barge

HTTPcURLJavaScriptPython

PUT /tmining/api/v1/releases/{address}/assign_barge HTTP/1.1
Host: url:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "identification": "text",
  "visitNumber": "text"
}

No content

EXAMPLE

ASSIGN a barge to a release (without type in URL):

server = https://url:port/tmining/api/v1

ASSIGN a barge to a release (with type in URL):

server = https://url:port/tmining/api/v1

---

ASSIGN (train)

Assign a train to a release

put

https://url:port/tmining/api/v1https://test-admin.securecontainerrelease.com:4430/legacy/tmining/api/v1

/releases/{address}/assign_train

Assign a train with identification and visit number.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Body

application/json

identificationstringRequired

The identification number of the train

visitNumberstringOptional

The visit number of the train

Responses

204

Request accepted

401

Invalid Authorization bearer token

403

Access forbidden

404

Release not found

500

Internal server error

put

/releases/{address}/assign_train

HTTPcURLJavaScriptPython

PUT /tmining/api/v1/releases/{address}/assign_train HTTP/1.1
Host: url:port
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "identification": "text",
  "visitNumber": "text"
}

No content

EXAMPLE

ASSIGN a train to a release (without type in URL):

server = https://url:port/tmining/api/v1

ASSIGN a train to a release (with type in URL):

server = https://url:port/tmining/api/v1