MPET

createVoyage

POST

/hna/voyages:create

Operator - Voyages

Create a barge voyage, also known as a rotation

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/hna/voyages:create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "voyageData": {
        "modality": "string"
    },
    "contactPerson": {
        "name": "string",
        "emailAddress": "string",
        "phoneNumber": "string"
    }
}'

Response Example

{
  "voyageId": "string"
}

Request

Body Params application/json

voyageData

object (HnaVoyageData)

required

modality

string

required

contactPerson

object (HnaContactPerson)

optional

name

string

required

emailAddress

string

optional

phoneNumber

string

optional

Examples

Responses

🟢200default response

application/json

Body

voyageId

string

optional

cancelVoyage

getVoyage