API Reference

addVesselsToVoiBylmo

Adds vessels to Vessel of Interest (VOI) lists.

Arguments

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

Returns

NameDescription
VOIThe Vessel of Interest list name and ID to which the vessels are added.

VOI Fields

NameTypeDescription
idObjectIdThe unique Windward assigned ID of the VOI to which the vessels are added.
nameStringThe name of the VOI to which the vessels are added.

Example Code

Sample Mutation

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

Variables

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

Response

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