API Reference

shipmentGeoJSON

Returns all GeoJSON map elements by shipment.

Geospatial data interchange format based on JavaScript Object Notation (JSON). It defines several types of JSON objects and the manner in which they are combined to represent data about geographic features, their properties, and their spatial extents.

Arguments

NameTypeDescription
id[ObjectId!]!The shipment's unique Windward assigned ID.

Returns

NameDescription
GeoJSONFeatureCollectionScalarGeoJSONFeatureCollectionScalar is a JSON description of the shipment's geographic features, properties, and spatial extents.

Example Code

Sample Query

query Query($shipmentGeoJsonId: ObjectId!) {
  shipmentGeoJSON(id: $shipmentGeoJsonId)
}

Variables

{
  "shipmentGeoJsonId": "60d9a3d45636fae0eab9ae82"
}

Response

{
  "data": {
    "shipmentGeoJSON": {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "LINE",
            "imo": "9326952",
            "name": "TROUPER",
            "voyage": "118E",
            "stroke-width": 4,
            "stroke": "#3f95f5"
          },
          "geometry": {
            "type": "LineString",
            "coordinates": [
              [
                4.83348166666667,
                43.4189133333333
              ],
              [...]
            ]
          }
        },
        {
          "type": "Feature",
          "properties": {
            "type": "BLIP",
            "datetime": "2021-06-02T05:52:57.000Z",
            "id": "5905c34ff211af4c5ec8b762",
            "imo": "9326952",
            "name": "TROUPER",
            "voyage": "118E",
            "longitude": 4.83348166666667,
            "latitude": 43.4189133333333,
            "course": 132,
            "marker-size": "small",
            "marker-symbol": "ferry",
            "stroke": "#3f95f5"
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              4.83348166666667,
              43.4189133333333
            ]
          }
        }
      ]
    }
  }
}