/Cargo

Short Description

Chapter Contents:

Long Description

Supported Methods

GET /Cargo

Get a list of Cargo objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

GET /Cargo/{key}
Get a single Cargo object.

POST /Cargo
Insert a new Cargo object not allocated to a Voyage:

• Required fields:  

  • Cargo:  commodity, charterer, freightCurrency, cargoMeasurement, cargoPorts
    
    

POST example:

Insert a new Cargo object allocated to a Voyage:

If the cargo ports of the new cargo are not in the schedule of the Voyage, it is necessary create also the corresponding port calls, adding them at the end of the schedule.

In this example we want add a new cargo to a given voyage that has just two port calls, So the new port calls must have portCallSequence 3 and 4:

POST example:

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:

The starting portCallSequence to use to create the Cargo will be the max portCallSequence returned by this call plus 1.

If the port of the CargoPort are instead already in the schedule, the following JSON can be post to create a new Cargo:

Indicating the PortCall key where the CargoPort must be attached.

PUT /Cargo/{key}

Update an existing Cargo. Unchanged properties need not be updated.  

Dates: Must be supplied in ISO format: yyyy-mm-dd hh:mm:ss

Example:

"cpDate":"2012-09-10 00:00:00"

Any field accepting a code also accept an ID: 

• Code fields (ResourceType: nameOfField): 

  • cargo:   

    • Commodity: commodity, subCommodity  

    • BusinessPartner: charterer  

    • Measurement: cargoMeasurement, dimensionMeasurement,freightMeasurement, volumeMeasurement, weightMeasurement, weightUnit   

    • Currency: freightCurrency, valueCurrency    

  • commissions:       
    
    

    • BusinessPartner: broker

  • various: 

    •  Currency: currency 

    • VariousText: variousText 

    • VariousRule: variousRule    

    • VariousType: variousType

  • cargoPort:
    
    

    • ReasonForCall: reasonForCall

    • LaytimeTerms: laytimeTerms

• ID Fields:

  • cargo: voyage 

  • cargoPorts: port
    
    

  • Non-ID fields without quotes are numeric values. 

  • Non-code fields with quotes are alphanumeric strings. 
    
    

Notes 

• When retrieving cargoes, template cargoes (the ones with isTemplate = true) should be filtered out

Lumpsum cargo: 

• cargoQuantity and freightRate must be assigned at Cargo level

Other cargoes: 

• Changing cargoQuantity in a cargoPort does not trigger any calculation on cargoQuantity of other cargoPort.

• The cargoQuantity at cargo level is calculated summing the cargoQuantity of loading ports

• It is not possible assign freightRate in both discharge and loading ports.

• The cargoQuantity used for calculations are those in cargoPort, cargoQuantity at Cargo level is not used in calculations

• Freight and freightRate used for calculations are those in cargoPort,

• API will not use stowageFactor and weightFactor from commodity

Properties