Replace a vessel's manifest

put

/vessels/{imo}/manifest

replaceManifest

The whole manifest at once — a PUT, because half a manifest is not a smaller manifest, it is a wrong one.

Autorisierung

Eines davon genügt
- apiKeyapiKey · X-Api-Key · Kopfzeile
  A key from the account page.
Eines davon genügt
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parameter

Pfad

imo*ErforderlichstringMuster ^IMO[0-9]{7}$
The vessel's IMO number.

Kopfzeile

If-Matchstring
The manifest revision you are replacing.

Anfragekörper Erforderlich

application/json

object

entries*Erforderlicharray<object>
Jedes Element
objectManifestEntry
- line*Erforderlichintegermin 1
- contents*Erforderlichany
  Mindestens eines von
  object
  consignmentIdstring
  object
  descriptionstring
  weightKgnumbermin 0

json

{
  "entries": [
    {
      "line": 1,
      "contents": {
        "consignmentId": "00000000-0000-4000-8000-000000000000"
      }
    }
  ]
}

Antworten

200

The manifest as it now stands.

application/json

array<object>

Jedes Element

objectManifestEntry

line*Erforderlichintegermin 1
contents*Erforderlichany
Mindestens eines von
- object
  consignmentIdstring
- object
  descriptionstring
  weightKgnumbermin 0

json

[
  {
    "line": 1,
    "contents": {
      "consignmentId": "00000000-0000-4000-8000-000000000000"
    }
  }
]

412

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*ErforderlichstringA short, human-readable summary.
status*Erforderlichintegermin 400max 599
detailstring | null

json

{
  "title": "string",
  "status": 400,
  "detail": "string"
}

Anfrage senden

curl 'https://api.example.org/v3/consignments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000' \
  -d '{
  "reference": "HB-1042",
  "status": "booked"
}'

Diese Seite bearbeiten