API Reference

readOnlyVesselProfileLink

Open the vessel profile page displaying information on the vessel type, behaviour, and risk .

Query Schema

type Query {
  readOnlyVesselProfileLink(vesselId: ObjectId, imo: String, startDate: DateTime, endDate: DateTime, sections: [VesselProfileSectionName!]): ReadOnlyVesselProfileLinkResponse
}

Arguments

NameTypeDescription
vesselIdObjectIdThe unique Windward assigned ID of the vessel whose profile is to be displayed.
imoStringThe International Maritime Organization ID of the vessel whose profile is to be displayed.
startDateDateTimeThe starting date of the time range within which profile data is captured.
endDateDateTimeThe end date of the time range within which profile data is captured.
endDate[VesselProfileSectionName!]The name of the vessel profile section.

Returns

NameDescription
ReadOnlyVesselProfileLinkResponseThe link returned by the readOnlyVesselProfileLink query.

ReadOnlyVesselProfileLinkResponsed Fields

NameTypeDescription
linkStringThe link returned by the readOnlyVesselProfileLink query.

Example Code

Sample Query

query ReadOnlyVesselProfileLink($imo: String) {
  readOnlyVesselProfileLink(imo: $imo) {
    link
  }
}

Variables

{
"imo": "9146558",
"startDate": "2022-06-01T06:00:00.000Z",
"endDate": "2022-12-20T06:00:00.000Z"
}

Response

{
"imo": "9146558",
"startDate": "2022-06-01T06:00:00.000Z",
"endDate": "2022-12-20T06:00:00.000Z"
}