Property | Type | Length | Mandatory | Description | Comments |
---|
agencySystemRef | String | 20 |
|
|
|
arrivalFixed | Boolean |
|
|
|
|
berthedFixed | Boolean |
|
|
|
|
boActual | Double |
|
|
|
|
boAllowed | Double |
|
|
|
|
boExcessCredit | Double |
|
|
|
|
boNitrogenContent | Double |
|
|
|
|
boOnPassage | Double |
|
|
|
|
boUsedAsFuel | Double |
|
|
|
|
bunkerExtraCost | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
comments | String | 64 |
|
|
|
daysAtSea | Double |
|
|
|
|
daysExtraInPort | Double |
|
|
|
|
daysInPort | Double |
|
|
|
|
departureFixed | Boolean |
|
|
|
|
distanceActual | Double |
|
|
|
|
dlAtSea | Double |
|
|
|
|
dlBunkerPrice | Double |
|
|
| Estimated price / average price of bunker of this type |
dlBunkerPriceNet | Double |
|
|
| Estimated price / average price of bunker of this type |
dlBunkered | Double |
|
|
|
|
dlBunkeredDate | Date |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
dlInPort | Double |
|
|
|
|
dlRobArrival | Double |
|
|
|
|
dlRobArrivalFixed | Boolean |
|
|
|
|
dlRobDeparture | Double |
|
|
|
|
dlRobDepartureFixed | Boolean |
|
|
|
|
dlSulphurPercent | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
doAtSea | Double |
|
|
|
|
doBunkerPrice | Double |
|
|
|
|
doBunkerPriceNet | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
doBunkered | Double |
|
|
|
|
doBunkeredDate | Date |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
doInPort | Double |
|
|
|
|
doRobArrival | Double |
|
|
|
|
doRobArrivalFixed | Boolean |
|
|
|
|
doRobDeparture | Double |
|
|
|
|
doRobDepartureFixed | Boolean |
|
|
|
|
doSulphurPercent | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
flAtSea | Double |
|
|
|
|
flBunkerPrice | Double |
|
|
| Estimated price / average price of bunker of this type |
flBunkerPriceNet | Double |
|
|
| Estimated price / average price of bunker of this type |
flBunkered | Double |
|
|
|
|
flBunkeredDate | Date |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
flInPort | Double |
|
|
|
|
flRobArrival | Double |
|
|
|
|
flRobArrivalFixed | Boolean |
|
|
|
|
flRobDeparture | Double |
|
|
|
|
flRobDepartureFixed | Boolean |
|
|
|
|
flSulphurPercent | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
foAtSea | Double |
|
|
|
|
foBunkerPrice | Double |
|
|
| Estimated price / average price of bunker of this type |
foBunkerPriceNet | Double |
|
|
| Estimated price / average price of bunker of this type |
foBunkered | Double |
|
|
| Please see /bunkerOrder resoruce. |
foBunkeredDate | Date |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
foInPort | Double |
|
|
|
|
foRobArrival | Double |
|
|
|
|
foRoBArrivalFixed | Boolean |
|
|
|
|
foRobDeparture | Double |
|
|
|
|
foRobDepartureFixed | Boolean |
|
|
|
|
foSulphurPercent | Double |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
gaugedNitrogenFactor | Double |
|
|
|
|
gaugedQuantityAfter | Double |
|
|
|
|
gaugedQuantityBefore | Double |
|
|
|
|
gaugedTimeAfter | Date |
|
|
|
|
gaugedTimeBefore | Date |
|
|
|
|
handlingCost | Double |
|
|
|
|
hasTransshipment | Boolean |
|
|
|
|
isDlPurchaseFinal | Boolean |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
isDoPurchaseFinal | Boolean |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
isFlPurchaseFinal | Boolean |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
isFoPurchaseFinal | Boolean |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
isHcFixed | Boolean |
|
|
|
|
isPcFixed | Boolean |
|
|
|
|
laytimeUsed | Double |
|
|
|
|
lngFoConsumptionActual | Double |
|
|
|
|
lngFoConsumptionAllowed | Double |
|
|
|
|
lngFoConsumptionDebit | Double |
|
|
|
|
lngFoEquivalent | Double |
|
|
|
|
distance | Double |
|
|
|
|
numberOfBerths | Integer |
|
|
|
|
pctBoActual | Double |
|
|
|
|
pctBoAllowed | Double |
|
|
|
|
portCallSequence | Integer |
|
|
|
|
portCost | Double |
|
|
|
|
portCostCurrency | Double |
|
|
|
|
quantity | Double |
|
|
|
|
tcSequence | Integer |
|
|
|
|
timezoneOffset | Double |
|
|
|
|
variousCost | Double |
|
|
|
|
variousRevenue | Double |
|
|
|
|
agent | /BusinessPartner |
|
|
|
|
bunkerAccountOf | /BusinessPartner |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
bunkerBroker | /BusinessPartner |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
bunkerHedgeLine | /BunkerHedgeLine |
|
|
|
|
bunkerPayedBy | /BusinessPartner |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
bunkerSupplier | /BusinessPartner |
|
|
| Deprecated from version 3.5, please see /bunkerOrder resoruce. |
commodity | /Commodity |
|
|
|
|
currency | /Currency |
| Yes |
|
|
distanceRef | /Distance |
|
|
|
|
master | /Individual |
|
|
|
|
ownedByVoyage | /Voyage |
| Yes |
|
|
port | /Port |
| Yes |
| To set port: port key must be used (see: the port resource, for example: Port?filter=portName(EQ)OSLO). |
reasonForCall | /ReasonForCall |
| Yes |
| To see all available reason for calls: GET ReasonForCall |
speedRef | /Speed |
|
|
|
|
terminal | /Terminal |
|
|
|
|
voyage | /Voyage |
|
|
|
|
eventLogs | Array of /EventLog |
|
|
|
|
agencyAppointmentStatus | /StatusType |
|
|
| With StatusClass "AAP" |
portAgents | List of portAgents |
|
|
|
|
isFirstLoadPort | Boolean |
|
|
| calcculated field |
previousPortCall | 946241585 |
|
|
| Returns the previous portCall in the schedule. Available from version 3.23 |
portCaptain | /Individual |
|
|
| Available from version 3.23 |
zone | String |
|
|
| Available from version 5.16 |
draft | Double |
|
|
| Available from version 5.16 |
draftMeasurement | String |
|
|
| Available from version 5.16 |
waterSalinity | String |
|
|
| Available from version 5.16 |
waterDensity | Double |
|
|
| Available from version 5.16 |
safetyMargin | Integer |
|
|
| Available from version 5.16 |
constantReduction | Double |
|
|
| Available from version 5.16 |
freshWaterReduction | Double |
|
|
| Available from version 5.16 |
draftReduction | Double |
|
|
| Available from version 5.16 |
availableForCargo | Double |
|
|
| Available from version 5.16 |
cargoPorts | Array of /CargoPort |
|
|
|
|
ecaAvoidanceFactor | Integer |
|
|
|
|
iceAvoidanceFactor | Integer |
|
|
|
|
hraAvoidanceFactor | Integer |
|
|
|
|
allowKc | Integer |
|
|
|
|
allowNep | Integer |
|
|
|
|
allowNwp | Integer |
|
|
|
|
allowPc | Integer |
|
|
|
|
allowSc | Integer |
|
|
|
|
isLaytimeUsedFixed | Boolean |
|
|
|
|
daysExtraAtSea | Double |
|
|
|
|
percentExtraAtSea | Double |
|
|
|
|
daysStoppages | Double |
|
|
|
|
weatherAdjustmentDays | Double |
|
|
|
|
notToCounts | Array of /NotToCount |
|
|
|
|
isLastPortCall | Boolean |
|
|
|
|