MPET

createVisit

POST

/hna/visits:create

Operator - Visits

Create a barge visit, also known as a call

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/hna/visits:create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "voyageId": "string",
    "visitData": {
        "modality": "string",
        "externalReferenceVisit": "string",
        "eta": "string"
    },
    "terminal": {
        "shortName": "string",
        "ean": "string",
        "smdgCode": "string",
        "bicsCode": "string",
        "quayName": "1742"
    }
}'

Response Example

{
  "visitId": "string"
}

Request

Body Params application/json

voyageId

string

required

visitData

object (HnaVisitData)

required

modality

string

optional

The way in which the transportation of the cargo takes place in the hinterland.

externalReferenceVisit

string

optional

The unique ID that is provided by BTS for this visit

eta

string

required

The expected time of arrival of the means of hinterland's transport at the terminal.

terminal

object (HnaTerminal)

required

shortName

string

optional

Code to identify the Terminal organisation.

ean

string | null

optional

European Article Numbering issued by Secure Logistics to identify the Terminal organisation.

smdgCode

string

optional

Terminal facility code according to the Ship Message Development Group.

bicsCode

string

optional

Terminal code according to the Terminal code table

quayName

string

optional

The name of the quay where a vessel can moor for loading, unloading or e.g. awaiting orders.

Example:

1742

Examples

Responses

🟢200default response

application/json

Body

visitId

string

required

cancelVisit

finalizeLoadDischargeList