API Reference

removeVesselsFromVOIByIMOs

Remove vessels from the Vessel of Interest lists.

Arguments

NameTypeDescription
voiIdObjectIdThe unique Windward assigned ID of the VOI to which the vessels are added.
imos[String!]!The vessels International Maritime Organization ID of the vessels to remove from the list.

Returns

NameDescription
VOIThe Vessel of Interest list name and ID from which the vessels are removed.

VOI Fields

NameTypeDescription
idObjectIdThe unique Windward assigned ID of the VOI from which the vessels are removed.
nameStringThe name of the VOI from which the vessels are removed.

Example Code

Sample Mutation

mutation RemoveVesselsFromVOIByIMOs($voiId: ObjectId!, $imos: [String!]!) {
  removeVesselsFromVOIByIMOs(voiId: $voiId, imos: $imos) {
    id
    name
  }
}

Variables

{
  "voiId": "63a84e070f405d00118234fd",
  "imos": "9515539"
}

Response

{
  "data": {
    "removeVesselsFromVOIByIMOs": {
      "id": "63a84e070f405d00118234fd",
      "name": "New-VOI"
    }
  }
}