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:
...
Property | Type | Length | Mandatory | Description | Comments |
---|---|---|---|---|---|
| |||||
| |||||
| |||||
| String | 256 | |||
| Date | ||||
| String | 16 | |||
| String | 4 | |||
| String | 64 | |||
| Double | ||||
| Array of /CargoPort | ||||
| Array of /Various | ||||
| Array of /Commission | ||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | Defines wether or not the cargo is a template. Template cargoes are created when creating CoA and are used to create fixtures. | Added in version 5.6 | ||
| Boolean | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Yes | ||||
| Yes | ||||
| |||||
| |||||
| Yes | ||||
| Yes | ||||
| Yes | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| |||||
| |||||
| Date | ||||
| Date | ||||
| Date | ||||
| String | 1 | Yes | ||
| String | 64 | |||
| |||||
| |||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Date | ||||
| Double | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Double | ||||
| Integer | ||||
| Integer | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 25 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Integer | ||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| Yes | ||||
| Double | ||||
| |||||
| Date | from API 3.3 | |||
| Date | from API 3.3 | |||
| from API 3.3 | ||||
| |||||
| |||||
| Array of /FreightRate | ||||
| Double | ||||
| Boolean | from API 6.26 | |||
| from API 6.26 | ||||
| from API 6.28 | ||||
| Double | The sum of all freight adjustments on the cargo | from API 6.28 | ||
office | from API 6.33 | ||||
| from API 6.33 |
Note |
---|
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss) |
...
Example Response Body
Code Block | ||
---|---|---|
| ||
{ "commodity": null,{ "subCommoditycommodityName": "Mabl nullCommodity", "charterer": null, "portRotationcommodityCode": "TRONDHEIM-BERGEN/STAVANGER-OSLOMABL", "cpDate "key": null13670798, "cargoReferenceself": "8316445"http://rocketleague1.dataloy.com:8080/ws/rest/Commodity/13670798" }, "cargoSubReferencesubCommodity": null, "externalReferencecharterer": null, { "scenariosbusinessPartnerName": ["Mabl Charterer", { "businessPartnerSort": "Mabl Charterer", "keybusinessPartnerCode": 6015476"105", "portAgentType": null, "self": "https://dev.dataloy.com/ws/rest/Scenario/6015476",businessPartnerType": { "fleetPlanbusinessPartnerType": { "C", "businessPartnerTypeDesc": "Charterer", "key": 14741271000032, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/FleetPlanBusinessPartnerType/14741271000032" }, } "key": 13669721, ], "areaself": null, "company": { "key": 1000001, "self": "https"http://devrocketleague1.dataloy.com:8080/ws/rest/CompanyBusinessPartner/100000113669721", }, "companyNameportRotation": "Dataloy SystemsBREMEN/LIVORNO", "cpDate": null, "companyCodecargoReference": "1456313875375", "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:32http://rocketleague1.dataloy.com:8080/ws/rest/Scenario/6015476", "baselineTerm": null, "commissionfleetPlan": 0.0,{ "vc": null, "handlingCost": 0.0, "freightRatekey": 0.01474127, "leg": null, "coaLine": null, "reletOfCargoself": "http: null,//rocketleague1.dataloy.com:8080/ws/rest/FleetPlan/1474127" "isPerformanceCargo": false, "cargoQuantity": 0.0 } } ], "createdById": 999999, "businessUnitvoyage": { "key": 100057613875364, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/BusinessUnitVoyage/100057613875364", }, "businessUnitNamearea": "Dry Bulk", null, "businessUnitCodecreatedDate": "DRY"2023-04-21T08:29:26", }"exchangeRate": 1.0, "cargoPortsexternalObjectKey": [null, "modifiedDate": "2023-04-21T12:41:02", { "company": { "key": 831644813668967, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/CargoPortCompany/831644813668967", }, "companyName": "Mabl Company", { "companyCode": "MABL", "keydefaultBankAccount": 8316447 null }, "paymentTerms": { "selfkey": "https1004279, "self": "http://devrocketleague1.dataloy.com:8080/ws/rest/CargoPortPaymentTerms/83164471004279", }, "paymentTermsCode": "10D" }, { "baselineTerm": { "key": 83164501004265, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/CargoPortBaselineTerm/83164501004265", } "baselineTermCode": "ARBL", { "baselineTermDesc": "After Release of Bill of Lading" "key": 8316469}, "self"commission": "https://dev.dataloy.com/ws/rest/CargoPort/8316469" } ]0.0, "isTemplatevc": falsenull, "commissionBrokerhandlingCost": 0.0, "laycanFromfreightRate": null10.0, "laycanMissedByleg": 0.0null, "laycanTocoaLine": null, "commissionscargoPorts": [], "comments": null, "commissionAddress": 0.0 { "key": 13875378, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/CargoPort/13875378" }, { "key": 13875377, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/CargoPort/13875377" } ], "reletOfCargo": null, "isPerformanceCargo": false, "cargoQuantity": 5600.0, "businessUnit": { "key": 13670758, "self": "http://rocketleague1.dataloy.com:8080/ws/rest/BusinessUnit/13670758", "businessUnitName": "Mabl Business Unit", "businessUnitCode": "MABL" }, "isOption": false, "isTemplate": false, "commissionBroker": 0.0, "laycanFrom": null, "laycanMissedBy": 0.0, "laycanTo": null, "commissions": [], "adjustment": 18592.800000000003, "comments": null, "commissionAddress": 0.0, "demurrage": 0.0, "despatch": 0.0, "doPrice": 0.0, "eeoi": 24.208296035498126, "foPrice": 0.0, "freight": 56000.0, "grossFreight": 74592.8, "netFreight": 56000.0, "variousCost": 0.0, "variousRevenue": 0.0, "variouses": [], "isIssuedLoi": null, "laytimeUsed": 0.0, "volume": 0.0, "arrivalWindowFrom": null, "arrivalWindowMissedBy": 0.0, "arrivalWindowTo": null, "blDate": null, "bookedQuantity": 5600.0, "cargoMatch": "1", "cargoText": null, "demurragedeadfreight": 0.0, "despatchdeadfreightRate": 0.0, "doPricedemurrageRate": 0.0, "eeoidespatchRate": 0.0, "foPricedoBunkerAdjustment": 0.0, "finalDestination": null, "freightflatRate": 0.0, "grossFreightfoBunkerAdjustment": 0.0, "netFreightfreightAmountCurrency": 056000.0, "variousCosthasEqualization": 0.0false, "variousRevenuehasN2Padding": 0.0false, "variousesheight": []null, "arrivalWindowFromisCradleRequired": nullfalse, "arrivalWindowMissedByisDemurrageFixed": 0.0false, "isIssuedLoiisDespatchFixed": nullfalse, "laytimeUsedisExclusive": 0.0false, "volumeisLaycanAgreed": 0.0null, "arrivalWindowToisLifo": nullfalse, "blDateisLumpsum": nullfalse, "bookedQuantityisOnDeck": 0.0false, "cargoMatchisReversible": "1"false, "cargoTextisWorldscale": nullfalse, "deadfreightlaycanTargetFrom": 0.0null, "deadfreightRatelaycanTargetTo": 0.0null, "demurrageRatelaytimeAllowed": 0.0, "despatchRatelaytimeExpireDate": 0.0null, "doBunkerAdjustmentlaytimeTermsValue": 0.0, "finalDestinationlaytimeUsedFromDate": null, "flatRatelaytimeUsedToDate": 0.0null, "foBunkerAdjustmentmaxTransitTime": 0.0, "freightAmountCurrencyminimumQuantity": 0.0, "hasEqualizationnetFio": false10.0, "hasN2PaddingonDeckOption": false, "heightoverrage": null0.0, "isCradleRequiredpctOverage": false50, "isDemurrageFixedpctPrepaid": false100, "isDespatchFixedpieces": false0.0, "isExclusiveplaceOfOrigin": falsenull, "isLaycanAgreedquantityOptionPct": null0.0, "isLifoshipFigure": false0.0, "isLumpsumspecificGravity": false0.0, "isOnDeckspecificGravityTemperature": false0.0, "isReversiblestowageFactor": false0.0, "isWorldscaleterms": falsenull, "laycanTargetFromtimeNotToCount": null0.0, "laycanTargetTotimeOnDemurrage": null0.0, "laytimeAllowedtimeOnDespatch": 0.0, "laytimeExpireDateweight": null5600.0, "laytimeTermsValueweightFactor": 0.0, "laytimeUsedFromDatewidth": null, "laytimeUsedToDatewsYear": null, "maxTransitTimebaselineTerm2": 0.0null, "minimumQuantitybookingStatus": 0.0,{ "netFio": 0.0, "onDeckOptionkey": false6022839, "overrage": 0.0, "pctOverageself": 50"http://rocketleague1.dataloy.com:8080/ws/rest/StatusType/6022839", "pctPrepaid": 100, "piecesstatusTypeCode": 0.0"POSS", "placeOfOriginstatusTypeDesc": null,"Possibility" "quantityOptionPct": 0.0}, "shipFigurecargoMeasurement": 0.0,{ "specificGravitymeasurementCode": 0.0"MT", "specificGravityTemperaturekey": 0.01000578, "stowageFactorself": 0.0,"http://rocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" "terms": null}, "timeNotToCountcargoType": 0.0,{ "timeOnDemurragekey": 0.06021782, "timeOnDespatch": 0.0, "weightself": 0.0"http://rocketleague1.dataloy.com:8080/ws/rest/CargoType/6021782", "weightFactor": 0.0, "widthcargoTypeCode": null,"SPOT" "wsYear": null}, "baselineTerm2coatingType": null, "bookingStatusdemurrageTimeBarEvent": { "key": 60230091000052, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/StatusTypeEvent/60230091000052", "statusTypeCodeeventCode": "POSSDEP", "statusTypeDesceventDesc": "PossibilityDeparted" }, "cargoMeasurementdimensionMeasurement": { "measurementCode": "MT", null, "keyfreightAdjustments": 1000578, "self": "https://dev.dataloy.com/ws/rest/Measurement/1000578"[ }, { "cargoType": { "key": 602178013875661, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/CargoTypeFreightAdjustment/602178013875661", "cargoTypeCode": "SPOT" }, "coatingType": null, { "demurrageTimeBarEvent": { "key": 100005213875568, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Event/1000052", "eventCode": "DEP",FreightAdjustment/13875568" "eventDesc": "Departed" }, "dimensionMeasurement": null], "freightCurrency": { "currencyCode": "USD", "currencyName": "U.S. Dollar", "key": 400132, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Currency/400132" }, "freightMeasurement": { "measurementCode": "MT", "key": 1000578, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" }, "freightRates": [], "laytimeTerms": null, "optionStatus": { "key": 1000105, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/StatusType/1000105", "statusTypeCode": "NOT", "statusTypeDesc": "Not declared" }, "payee": null, "paymentTerms2": null, "project": null, "quantityOption": null, "stowageUnit": { "measurementCode": "MT", "key": 1000578, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" }, "subCargos": [], "supplier": null, "tsOfCargoPort": null, "valueCurrency": { "currencyCode": "USD", "currencyName": "U.S. Dollar", "key": 400132, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Currency/400132" }, "volumeMeasurement": { "measurementCode": "CBM", "key": 1000579, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Measurement/1000579" }, "weightMeasurement": { "measurementCode": "MT", "key": 1000578, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" }, "weightUnit": { "measurementCode": "MT", "key": 1000578, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Measurement/1000578" }, "length": null, "value": null, "remarks": [], "isObjectActive": true, "key": 831644513875375, "self": "httpshttp://devrocketleague1.dataloy.com:8080/ws/rest/Cargo/831644513875375" } |
Related Content
...