Version à venir

Vous consultez la documentation d’une version à venir. Sa documentation et ses fonctionnalités peuvent encore changer.

Cette page n’est pas encore disponible dans votre langue

Vous la lisez en English (UK).

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.

Autorisation

L’un de ceux-ci suffit
- apiKeyapiKey · X-Api-Key · En-tête
  A key from the account page.
L’un de ceux-ci suffit
- bearerhttp · bearer
  A token obtained from the authorisation server.

Paramètres

Chemin

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

En-tête

If-Matchstring
The manifest revision you are replacing.

Corps de la requête Obligatoire

application/json

object

entries*Obligatoirearray<object>
Chaque élément
objectManifestEntry
- line*Obligatoireintegermin 1
- contents*Obligatoireany
  Au moins l’un de
  object
  consignmentIdstring
  object
  descriptionstring
  weightKgnumbermin 0

json

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

Réponses

200

The manifest as it now stands.

application/json

array<object>

Chaque élément

objectManifestEntry

line*Obligatoireintegermin 1
contents*Obligatoireany
Au moins l’un de
- 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*ObligatoirestringA short, human-readable summary.
status*Obligatoireintegermin 400max 599
detailstring | null

json

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

Envoyer une requête

curl 'https://api.example.org/v3/consignments?limit=20&cursor=string&status=%5B%0A++%22booked%22%0A%5D&session=string' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000'

Modifier cette page