Short Description
The Dataloy REST API has been streamlined and made more generic since previous versions. If you used one of the older versions this page is a useful overview of the changes. If you are a new user, please see Getting Started with Dataloy REST API instead. Changes in this version includes:
...
Chapter Contents:
Table of Contents |
---|
maxLevel | 4 |
---|
minLevel | 4 |
---|
absoluteURL | true |
---|
type | flat |
---|
|
Long Description
Filtering
Filtering in prior versions of Dataloy API has been replaced by the new generic filtering functionality. Prior versions:
...
Code Block |
---|
http://localhost/ws/rest/BusinessPartner?filter=modifiedDate(GT)2014-01-01T00:00:00 |
Common Properties
Some properties are common to all objects and have in version 1.00 been removed. However, modifiedDate has been added to avoid confusion between changedDate and recalculatedDate:
No Format |
---|
Removed:
attachmentCount
auditDate
changedById
changedDate (use modifiedDate)
realmId
recalculatedDate (use modifiedDate)
recordStatus
remarkCount
Added:
modifiedDate
All existing common fields:
createdDate
modifiedDate
key
self
|
List of Changes
List of Changes to Some of the Most Used Sntities:
BusinessPartner
No Format |
---|
Renamed:
bankAccountsFromBusinessPartner renamed to bankAccounts
individualsFromBusinessPartner renamed to individuals
Removed:
coasFromGuarantor
tcsFromGuarantor |
BusinessUnit
No Format |
---|
Removed:
cargosFromBusinessUnit
commoditysFromBusinessUnit
companyHasBusinessUnitsFromBusinessUnit |
Cargo
No Format |
---|
Added:
bookingStatus (type: StatusType)
Renamed:
variouss renamed to variouses
Removed:
brokerName
cargoAbsorptionsFromCargo
cargoContributionsFromCargo
cargoStowsFromCargo
cargosFromReletOfCargo
chartererName
claimsFromCargo
coa
commissionDemurrage
commodityName
crudeOil
demurrageCurrency
demurrageTimeBar
documentLinesFromCargo
exporter
freightAmountCurrency
isCargoIgnored
isLaycanReachable
laytimesFromCargo
managementCommissionBase
maxHl
outturnQuantity
receiver
reversibleMatchsFromCargo
route
stowageContract
subCommodityName
tcResultDayContribution
timeFromDemurrageBank
vc |
CargoPort
No Format |
---|
Removed:
agent
billOfLadingsFromCargoPort
cargoPortCostsFromCargoPort
cargoPortHasEventLogsFromCargoPort
cargoPortHasHcsFromCargoPort
cargoPortHasVarioussFromCargoPort
cargoPortMiles
cargoReference
cargoText
cargosFromTsOfCargoPort
charterer
commodity
demurrageRate
demurrageRateRef
demurrageTimeBar
despatchRate
despatchRateRef
documentLinesFromCargoPort
extraBallPort1
extraBallPort2
extraPort1
extraPort2
inUse
isOwnersAgent
notToCountsFromCargoPort |
Commission
No Format |
---|
Removed:
cargoHasCommissionsFromCommission
coaHasCommissionsFromCommission
commissionAmountCurrency
documentLinesFromCommission
ffaHasCommissionsFromCommission
isBunkerAdjApplicaple
isDemurrageApplicable
isVariousApplicable
tcHasCommissionsFromCommission |
Company
No Format |
---|
Removed:
companyHasBankAccountsFromCompany
companyHasBusinessUnitsFromCompany
defaultBankAccount |
Document
No Format |
---|
Renamed:
documentLinesFromDocument renamed to documentLines
documentPaymentTermssFromDocument renamed to documentPaymentTerms
Changed:
invoicingStatus (was String, now StatusType)
Removed:
bankAccountCode
businessPartnerCode
businessPartnerName
companyCode
companyName
documentCurrencyCode
documentCurrencyName
documentTypeCode
documentTypeName
issuingCompanyCode
issuingCompanyName
status |
DocumentLine
No Format |
---|
Changed:
companyCurrencyAmount (was Integer, now Float)
documentAmount (was Integer, now Float)
invoicingStatus (was String, now StatusType)
quantity (was Integer, now Float)
sourceCurrencyAmount (was Integer, now Float)
unitPrice (was Integer, now Float)
Removed:
account
claim
documentCurrencyCode
prepaidPct
sourceCurrencyCode
status (use invoicingStatus instead)
vat
vatCode
vc
voyageNo
voyageReferenceNo (use voyage instead)
voyageStartYear
voyageVesselCode
voyageVesselName |
EventLog
No Format |
---|
Removed:
eventCode
eventDesc
eventType |
Event
No Format |
---|
Removed:
positionReportsFromEvent |
ExchangeRate
No Format |
---|
Removed:
isBudget |
FreightRate
No Format |
---|
Removed:
documentLinesFromFreightRate |
Individual
No Format |
---|
Removed:
commissionsFromBrokerContact
portCallsFromMaster
vesselCodesFromMaster
voyageHasMooringMastersFromMooringMaster
voyageHeadersFromMaster |
Measurement
No Format |
---|
Removed:
measurementType
measurementTypeRef |
PaymentTerms
No Format |
---|
Removed:
businessPartnersFromPaymentTerms
cargosFromPaymentTerms
cargosFromPaymentTerms2
coasFromPaymentTerms
documentLinesFromPaymentTerms
documentPaymentTermssFromPaymentTerms
documentsFromPaymentTerms |
PortAgent
No Format |
---|
Removed:
documentLinesFromPortAgent
portCostsFromPortAgent |
PortAgentType
No Format |
---|
Removed:
portAgentsFromPortAgentType |
PortCall
No Format |
---|
New:
distanceRef (type: Distance)
agencyAppointmentStatus (type: StatusType)
Changed:
distance (was Distance, now Float)
Renamed:
miles renamed to distance
Removed:
availableForCargo
bunkerPriceCurrency
bunkerReduction
bunkersFromPortCall
constantReduction
daysDlAtSea
daysDlAtSeaAe
daysDlInPort
daysDoAtSea
daysDoAtSeaAe
daysDoInPort
daysFlAtSea
daysFlInPort
daysFoAtSea
daysFoInPort
daysStoppages
distanceDeviation
documentLinesFromPortCall
draft
draftMeasurement
draftReduction
exchangeRate
exporter
freshWaterReduction
gasAtSea
gasInPort
gasLoaded
gasLoadedPrice
gasRobArrival
gasRobArrivalFixed
gasRobDeparture
gasRobDepartureFixed
isBallast
isChanged
isOverlapped
isPortIgnored
isRoutingPoint1Fixed
isRoutingPoint2Fixed
isSpeedChanged
nextPortCall
numberOfOccurances
pcallHasBolsFromPortCall
percentExtraAtSea
portAgentsFromPortCall
portCallHasVarioussFromPortCall
portStevedoresFromPortCall
positionReportsFromPortCall
receiver
routingPoint1
routingPoint2
safetyMargin
speed
waterDensity
waterSalinity
weatherAdjustmentDays
weatherAdjustmentFo
weatherAdjustmentMiles
zone |
Port
No Format |
---|
Removed:
bunkerCategoryAe
bunkerCategoryMe
distancesFromFPort
distancesFromRp
distancesFromTPort
portAltsFromPort
portCodesFromPort
portRef
terminalsFromPort
wpoint
zoomLevel |
ReasonForCall
No Format |
---|
Removed:
cargoPortsFromReasonForCall
cargoStowsFromReasonForCall
coaPortsFromReasonForCall
portCallsFromReasonForCall
tradePortsFromReasonForCall |
Speed
No Format |
---|
Removed:
portCallsFromSpeedRef
positionReportsFromSpeed
tcHasSpeedsFromSpeed
tcsFromBallastSpeed
tcsFromLoadedSpeed
vesselHasSpeedsFromSpeed |
StatusClass
No Format |
---|
Removed:
fieldHasStatusClasssFromStatusClass
statusTypesFromStatusClass
tableHasStatusClasssFromStatusClass |
StatusType
No Format |
---|
Removed:
statussFromStatusType |
SubCommodity
No Format |
---|
Removed:
billOfLadingsFromSubCommodity
cargosFromSubCommodity
coaPortsFromSubCommodity
coaRangesFromSubCommodity
coasFromSubCommodity
crudeOil |
User
No Format |
---|
Removed:
coasFromCargoOperator
coasFromCharteringResponsible
coasFromOperator
tcsFromCharteringResponsible
tcsFromOperator |
VariousRule
No Format |
---|
Removed:
emissionFeesFromVariousRule
variousTextsFromVariousRule
varioussFromVariousRule |
VariousText
No Format |
---|
Removed:
accountMappingsFromToVariousText
accountMappingsFromVariousText
documentLinesFromVariousText
tableHasVariousTextsFromVariousText
varioussFromVariousText |
Various
No Format |
---|
Removed:
billOfLadingHasVarioussFromVarious
cargoHasVarioussFromVarious
cargoPortHasVarioussFromVarious
claimHasVarioussFromVarious
coaHasVarioussFromVarious
coaRangeHasVarioussFromVarious
documentDate
documentLinesFromVarious
documentReference
exchangeRate
hasAddressCommission
offhireHasVarioussFromVarious
portCallHasVarioussFromVarious
source
voyageHasVarioussFromVarious |
VariousType
No Format |
---|
Removed:
variousTextsFromVariousType
varioussFromVariousType |
Vessel
No Format |
---|
Added:
speeds (type: array of Speed)
vesselCodes (type: array of VesselCode)
Removed:
budgetVoyageStartsFromPlannedVessel
cargoPortsFromTransshipmentVessel
claimOperatorCode
classificationSocietyCode
cofsFromVessel
cubicMeasurementCode
defaultBankAccountCode
defaultBusinessUnitCode
defaultCompanyCode
dwtMeasurementCode
fleetEntryDate
fleetExitDate
headOwnerPniClubCode
hnmClubCode
hnmGrossValue
holdGroupsFromVessel
holdsFromVessel
homogeneousIntakesFromVessel
masterAccountCode
masterName
nextDryDockDate
nextDryDockDuration
operatingCostPerDay
operatorCode
pniClubCode
pniEntryDate
pniExitDate
poolCode
similarTonnagesFromVessel
speedBallastList (use speeds instead)
speedLoadedList (use speeds instead)
supportGearsFromSupportVessel
vesselClassCode
vesselCode (replaced with vesselCodes)
vesselEmissionsFromVessel
vesselGroupHasVesselsFromVessel
vesselHasBunkerTypesFromVessel
vesselHasEmissionFeesFromVessel
vesselHasSpeedsFromVessel
vesselSeriesName |
VesselCode
No Format |
---|
Renamed:
tcsFromVesselCode renamed to tcs
Removed:
documentLinesFromVesselCode
financialDailyUpdatesFromVesselCode
idlesFromVesselCode
offhireUnplannedsFromVesselCode
offhiresFromVesselCode
poolEarningPointsFromVesselCode
vouchersFromVesselCode
voyageHeadersFromVesselCode |
Voyage
No Format |
---|
Added:
tcs (what was this called before??)
Removed:
backhaulSaving
backhaulSavingFactor
budgetVoyageStart
bunkerEscalation
businessUnitName
canal1
canal2
cpDate
daysBallastDirect
daysBallastOffset
daysCanalDirect
dischargingCosts
doConsumptionOffhire
doCostDirect
estimatedDlRobVoyageStart
estimatedDoRobVoyageStart
estimatedFlRobVoyageStart
estimatedFoRobVoyageStart
firstPortCall
foConsumptionOffhire
foCostDirect
gasConsumption
gasConsumptionOffhire
gasPrice
hasCanalPassage
hasCleaning
hasHeating
hasPumping
hasRelet
hasTransshipment
isInReverseMode
isIntakeCalculated
isRotationProtected
isTcResultPerMonth
loadingCosts
marketRatePerDay
maxPortCallSequence
milesDirect
minCargo
offsetBallastPort
policy
progress
rpBallast
rpLoaded
stblVessel
stblVesselEta
supportEndDate
supportGear
supportStartDate
supportVessel
tcIdIn (RENAMED to tcIn)
tcIdRelet
varianceOnSensitivity
voyageEndDate
voyageEndDateGMT
voyageHeaderReferenceNo (Can still be found on VoyageHeader)
voyageHeadersFromVoyage (use voyageHeader)
voyageStartDate
voyageStartDateGMT
voyageType |
No Format |
---|
Changed:
voyageStatus (was String, now StatusType)
Renamed:
offhiresFromVoyageHeader renamed to offhires
voyageSnapshotsFromVoyageHeader renamed to voyageSnapshots
Removed:
budgetVoyageStartsFromVoyageHeader
bunkerPort
claimsFromVoyageHeader
daysDischargingCorr
daysExtraInPortCorr
daysLoadedCorr
daysLoadingCorr
deliveryDate
dlPriceDelivery
dlPriceRedelivery
dlRobDelivery
dlRobRedelivery
doPriceDelivery
doPriceRedelivery
doRobDelivery
doRobRedelivery
flPriceDelivery
flPriceRedelivery
flRobDelivery
flRobRedelivery
foPriceDelivery
foPriceRedelivery
foRobDelivery
foRobRedelivery
gasConsumptionOffhire
gasPriceEndOfVoyage
gasPriceVoyageStart
gasRobVoyageStart
isChanged
preliminaryVoyage
redeliveryDate
status (use voyageStatus instead)
targetDate
vcsFromVoyageHeader |
Top
Back
Related Content
Expand |
---|
title | Expand to see related content |
---|
|
Wiki Markup |
---|
{dynamiccontentbylabel:showLabels=false|showSpace=false} |
|