Versions Compared

Key

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

Short Description

...

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
languagejs
{
    "commodity": null,{
        "subCommoditycommodityName": null,"20 IMDG1 Container",
  "charterer": null,     "portRotationcommodityCode": "TRONDHEIM-BERGEN/STAVANGER-OSLOIMDG1TEU",
        "cpDatekey": null1469510,
        "cargoReferenceself": "8316445",http://rocketleague4.dataloy.com:8380/ws/rest/Commodity/1469510"
    "cargoSubReference": null},
    "externalReferencesubCommodity": null,
    "scenarioscharterer": [{
        {
"businessPartnerName": "Baffin",
           "keybusinessPartnerSort": 6015476,
  "BAFFIN",
         "selfbusinessPartnerCode": "https://dev.dataloy.com/ws/rest/Scenario/601547640006",
        "portAgentType": null,
  "fleetPlan      "businessPartnerType": {
 
              "keybusinessPartnerType": 1474127"C",
                "selfbusinessPartnerTypeDesc": "https://dev.dataloy.com/ws/rest/FleetPlan/1474127"Charterer",
            "key": 1000032,
  }         } "self": "http://rocketleague4.dataloy.com:8380/ws/rest/BusinessPartnerType/1000032"
  ],     "area": null,
    "company": {},
        "key": 10000011004299,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/CompanyBusinessPartner/10000011004299",
    },
    "companyNameportRotation": "Dataloy SystemsHASSELBY/BERGEN",
    "cpDate": null,
    "companyCodecargoReference": "1456313847347",
   
    "defaultBankAccountcargoSubReference": null
    },
    "paymentTermsexternalReference": null,
    "isOptionscenarios": false,
[
   "voyage": null,    {
"createdDate": "2023-02-27T09:13:15",     "createdById": 8313792,     "exchangeRatekey": 1.06015476,
    "externalObjectKey": null,        "modifiedDateself": "2023-02-27T09:13:32",http://rocketleague4.dataloy.com:8380/ws/rest/Scenario/6015476",
            "fleetPlan": {
                "key": 1474127,
                "self": "http://rocketleague4.dataloy.com:8380/ws/rest/FleetPlan/1474127"
            }
        }
    ],
    "createdDate": "2023-04-14T12:17:11",
    "freightAdjustments": [
        {
            "key": 13852974,
            "self": "http://rocketleague4.dataloy.com:8380/ws/rest/FreightAdjustment/13852974"
        },
        {
            "key": 13847481,
            "self": "http://rocketleague4.dataloy.com:8380/ws/rest/FreightAdjustment/13847481"
        },
        {
            "key": 13847479,
            "self": "http://rocketleague4.dataloy.com:8380/ws/rest/FreightAdjustment/13847479"
        },
        {
            "key": 13853020,
            "self": "http://rocketleague4.dataloy.com:8380/ws/rest/FreightAdjustment/13853020"
        }
    ],
    "createdById": 6026416,
    "exchangeRate": 1.0,
    "externalObjectKey": null,
    "modifiedDate": "2023-04-17T13:56:15",
    "area": null,
    "voyage": null,
    "company": {
        "key": 1000001,
        "self": "http://rocketleague4.dataloy.com:8380/ws/rest/Company/1000001",
        "companyName": "Dataloy Systems",
        "companyCode": "14563",
        "defaultBankAccount": null
    },
    "isOption": false,
    "paymentTerms": {
        "key": 1004279,
        "self": "http://rocketleague4.dataloy.com:8380/ws/rest/PaymentTerms/1004279",
        "baselineTermpaymentTermsCode": null,"10D"
    "commission": 0.0},
    "vcbaselineTerm": null, {
        "handlingCostkey": 0.0,1004269,
        "freightRateself": 0.0,"http://rocketleague4.dataloy.com:8380/ws/rest/BaselineTerm/1004269",
        "legbaselineTermCode": null"UROI",
        "coaLinebaselineTermDesc": null,
    "reletOfCargo": null,"Upon Receipt of Invoice"
     "isPerformanceCargo": false},
    "cargoQuantitycommission": 0.0,
    "businessUnitvc": {
 null,
      "keyhandlingCost": 1000576,
   0.0,
    "selffreightRate": "https://dev.dataloy.com/ws/rest/BusinessUnit/1000576",
   0.0,
    "businessUnitNameleg": "Dry Bulk"null,
        "businessUnitCode": "DRY"
    }"coaLine": null,
    "cargoPorts": [
        {
            "key": 831644813847349,
            "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/CargoPort/831644813847349"
        },
        {
            "key": 831644713847350,
            "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/CargoPort/831644713847350"
        },
    ],
   { "businessUnit": {
          "key": 83164501000576,
   
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/CargoPortBusinessUnit/8316450"
        }1000576",
        {
 "businessUnitName": "Dry Bulk",
          "keybusinessUnitCode": 8316469,
  "DRY"
    },
    "selfreletOfCargo": "https://dev.dataloy.com/ws/rest/CargoPort/8316469"null,
    "isPerformanceCargo": false,
  }     ]"cargoQuantity": 0.0,
    "isTemplate": false,
    "commissionBroker": 0.0,
    "laycanFrom": null,
    "laycanMissedBy": 0.0,
    "laycanTo": null,
    "commissions": [],
    "comments": null,
    "commissionAddress": 0.0,
    "demurrage": 0.0,
    "despatch": 0.0,
    "doPrice": 0.0,
    "eeoi": 0.0,
    "foPrice": 0.0,
    "freight": 0.0,
    "grossFreight": 0.0,
    "netFreight": 0.0,
    "variousCost": 0.0,
    "variousRevenue": 0.0,
    "variouses": [],
    "arrivalWindowFromisIssuedLoi": null,
    "arrivalWindowMissedBylaytimeUsed": 0.0,
    "isIssuedLoivolume": null0.0,
    "laytimeUsedarrivalWindowFrom": 0.0null,
    "volumearrivalWindowMissedBy": 0.0,
    "arrivalWindowTo": null,
    "blDate": null,
    "bookedQuantity": 0.0,
    "cargoMatch": "1",
    "cargoText": null,
    "deadfreight": 0.0,
    "deadfreightRate": 0.0,
    "demurrageRate": 0.0,
    "despatchRate": 0.0,
    "doBunkerAdjustment": 0.0,
    "finalDestination": null,
    "flatRate": 0.0,
    "foBunkerAdjustment": 0.0,
    "freightAmountCurrency": 0.0,
    "hasEqualization": false,
    "hasN2Padding": false,
    "height": null,
    "isCradleRequired": false,
    "isDemurrageFixed": false,
    "isDespatchFixed": false,
    "isExclusive": false,
    "isLaycanAgreed": null,
    "isLifo": false,
    "isLumpsum": false,
    "isOnDeck": false,
    "isReversible": false,
    "isWorldscale": false,
    "laycanTargetFrom": null,
    "laycanTargetTo": null,
    "laytimeAllowed": 0.0,
    "laytimeExpireDate": null,
    "laytimeTermsValue": 0.0,
    "laytimeUsedFromDate": null,
    "laytimeUsedToDate": null,
    "maxTransitTime": 0.0,
    "minimumQuantity": 0.0,
    "netFio": 0.0,
    "onDeckOption": false,
    "overrage": 0.0,
    "pctOverage": 50,
    "pctPrepaid": 100,
    "pieces": 0.0,
    "placeOfOrigin": null,
    "quantityOptionPct": 0.0,
    "shipFigure": 0.0,
    "specificGravity": 0.0,
    "specificGravityTemperature": 0.0,
    "stowageFactor": 0.0,
    "terms": null,
    "timeNotToCount": 0.0,
    "timeOnDemurrage": 0.0,
    "timeOnDespatch": 0.0,
    "weight": 0.0,
    "weightFactor": 0.0,
    "width": null,
    "wsYear": null,
    "baselineTerm2": null,
    "bookingStatus": {
        "key": 60230096022839,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/StatusType/60230096022839",
        "statusTypeCode": "POSS",
        "statusTypeDesc": "Possibility"
    },
    "cargoMeasurement": {
        "measurementCode": "MTTEU",
        "key": 10005781469515,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/10005781469515"
    },
    "cargoType": {
        "key": 60217806021782,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/CargoType/60217806021782",
        "cargoTypeCode": "SPOT"
    },
    "coatingType": null,
    "demurrageTimeBarEvent": {
        "key": 1000052,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Event/1000052",
        "eventCode": "DEP",
        "eventDesc": "Departed"
    },
    "dimensionMeasurement": null,
    "freightCurrency": {
        "currencyCode": "USD",
        "currencyName": "U.S. Dollar",
        "key": 400132,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Currency/400132"
    },
    "freightMeasurement": {
        "measurementCode": "MTTEU",
        "key": 10005781469515,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/10005781469515"
    },
    "freightRates": [],
    "laytimeTerms": null,
    "optionStatus": {
        "key": 1000105,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/StatusType/1000105",
        "statusTypeCode": "NOT",
        "statusTypeDesc": "Not declared"
    },
    "payee": null,
    "paymentTerms2": null,
    "project": null,
    "quantityOption": null,
    "stowageUnit": {
        "measurementCode": "MT",
        "key": 1000578,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/1000578"
    },
    "subCargos": [],
    "supplier": null,
    "tsOfCargoPort": null,
    "valueCurrency": {
        "currencyCode": "USD",
        "currencyName": "U.S. Dollar",
        "key": 400132,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Currency/400132"
    },
    "volumeMeasurement": {
        "measurementCode": "CBMCUFT",
        "key": 10005792474693,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/10005792474693"
    },
    "weightMeasurement": {
        "measurementCode": "MT",
        "key": 1000578,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/1000578"
    },
    "weightUnit": {
        "measurementCode": "MT",
        "key": 1000578,
        "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Measurement/1000578"
    },
    "length": null,
    "value": null,
    "remarks": [],
    "isObjectActive": true,
    "key": 831644513847347,
    "self": "httpshttp://devrocketleague4.dataloy.com:8380/ws/rest/Cargo/831644513847347"
}

Top
Back

Related Content

...