Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Short Description

...

Code Block
languagejava
{
   "cargoMeasurement":"MT",
   "freightCurrency":"USD",
   "charterer":30091200,
   "commodity":11401057,
   "optionStatus": 1000105,
   "cargoPorts":[
      {
         "cargoPortSequence":1,
         "reasonForCall":"L",
         "port":103309
      },
      {
         "cargoPortSequence":1,
         "reasonForCall":"D",
         "port":105724
      }
   ],
}

...

Code Block
languagejava
{
   "voyage":35651877,
   "cargoMeasurement":"MT",
   "freightCurrency":"USD",
   "charterer":30091200,
   "commodity":11401057,
   "optionStatus": 1000105,
   "cargoPorts":[
      {
         "cargoPortSequence":1,
         "reasonForCall":"L",
         "port":103309,
         "portCall":{
            "voyage":35651877,
            "reasonForCall":"L",
            "port":103309,
            "currency":"USD",
            "portCallSequence":3,
            "eventLogs":[
               {
                  "event":"BRT",
                  "eventLogDate":"2020-08-13T09:14:08"
               },
               {
                  "event":"DEP",
                  "eventLogDate":"2020-08-13T09:14:08"
               },
               {
                  "event":"ARR",
                  "eventLogDate":"2020-08-13T09:14:08"
               }
            ]
         }
      },
      {
         "cargoPortSequence":1,
         "reasonForCall":"D",
         "port":105724,
         "portCall":{
            "voyage":35651877,
            "reasonForCall":"D",
            "port":105724,
            "currency":"USD",
            "portCallSequence":4,
            "eventLogs":[
               {
                  "event":"BRT",
                  "eventLogDate":"2020-08-13T09:14:08"
               },
               {
                  "event":"DEP",
                  "eventLogDate":"2020-08-13T09:14:08"
               },
               {
                  "event":"ARR",
                  "eventLogDate":"2020-08-13T09:14:08"
               }
            ]
         }
      }
   ]
}

To know which should be the first portCallSequence value to use in the JSON, a GET.Voyage/{key} can be done passing the following fields as HTTP header parameter (see Adjust Number of Fields to be Returned from a Request):

{"portCalls":{"portCallSequence":"*"}}

that will return a JSON like this:

...

Code Block
languagejava
{
   "voyage":35663066,
   "cargoMeasurement":"MT",
   "freightCurrency":"USD",
   "charterer":30091200,
   "commodity":11401057,
   "optionStatus": 1000105,
   "cargoPorts":[
      {
         "cargoPortSequence":1,
         "reasonForCall":"L",
         "port":103309,
         "portCall":35663069
         
      },
      {
         "cargoPortSequence":1,
         "reasonForCall":"D",
         "port":101816,
         "portCall":35663071
      }
   ]
}

...