/CargoPort

Short Description

Chapter Contents:

1 Properties
2 Example Response Body

Long Description

Properties

Property	Type	Length	Mandatory	Description	Comments

Property	Type	Length	Mandatory	Description	Comments
`cargoPortSequence`	Integer			Cargo Port Sequence: First Load Port (LP)= 1, Second Load Port = 2, etc. First Discharge Port (DP) = 1 , Second Discharcge Port = 2, etc. Example: 1 load port and 1 discharge port: 1 Load 1 Discharge Example: 2 load ports and 2 discharge ports: 1 Load 2 Load 1 Discharge 2 Discharge
`port`	/Port		Yes
`reasonForCall`	/ReasonForCall		Yes
`cargoQuantity`	Double
`freightRate`	Double
`laytimeTermsValue`	Double
`laytimeTerms`	/LaytimeTerms
`handlingCostRate`	Double
`isHandlingCostLumpsum`	Boolean
`cargo`	/Cargo		Yes
`isBlActive`	Boolean
`hcMeasurement`	/Measurement
`variousCost`	Double
`variousRevenue`	Double
`demurrage`	Double
`despatch`	Double
`freight`	Double
`handlingCost`	Double
`exporter`	/BusinessPartner
`receiver`	/BusinessPartner
`terminal`	/Terminal
`laytimeUsed`	Double
`isDemurrageFixed`	Boolean
`isDespatchFixed`	Boolean
`laytimeAllowed`	Double
`laytimeExpireDate`	Date
`laytimeUsedFromDate`	Date
`laytimeUsedToDate`	Date
`outturnQuantity`	Double
`shipFigure`	Double
`timeNotToCount`	Double
`timeOnDemurrage`	Double
`volume`	Double
`weight`	Double
`tcRateIndex`	/MarketIndex
`transshipmentVessel`	/Vessel
`laytimeCounterpart`	/BusinessPartner
`isCargoQuantityFixed`	Boolean
`isFreeDespatch`	Boolean
`isLaytimeProrated`	Boolean
`isWorking`	Boolean
`laytimeQuantity`	Double
`onDockQuantity`	Double
`pctOfLaytimeUsed`	Double
`reversibleMatch`	String	1
`handlingCostCurrency`	/Currency
`handlingCostCurrencyAmount`	Double
`eventLogs`	List of EventLog
`demurrageTimeBarEvent`	/Event
`portCall`	/PortCall		Yes if the corresponding Cargo is allocated to a Voyage		from 5.11
`laytimeCalculation`	/LaytimeCalculation
`laytimeUsedMinutes`	Integer
`minutesNotToCount`	Integer
`laytimeAllowedMinutes`	Integer
`timeOnDemurrageMinutes`	Integer
`timeOnDespatchMinutes`	Integer
`timeOnDespatch`	Double
`notToCounts`	Array of /NotToCount
`eeoi`	Double

Example Response Body

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)

{
    "cargoPortSequence": 1,
    "port": {
        "portName": "SAFI",
        "unLoCode": "MASFI",
        "country": {
            "countryCode": "MA",
            "countryName": "MOROCCO",
            "key": 410126,
            "self": "http://localhost:8080/ws/rest/Country/410126"
        },
        "isCanal": false,
        "self": "http://localhost:8080/ws/rest/Port/101105",
        "key": 101105
    },
    "reasonForCall": {
        "reasonForCall": "L",
        "reasonForCallDesc": "Loading",
        "key": 1000059,
        "self": "http://localhost:8080/ws/rest/ReasonForCall/1000059"
    },
    "cargoQuantity": 1000,
    "freightRate": 0,
    "laytimeTermsValue": null,
    "laytimeTerms": {
        "key": 1089236,
        "self": "http://localhost:8080/ws/rest/LaytimeTerms/1089236",
        "laytimeTerms": "SHINC",
        "laytimeTermsCode": "C"
    },
    "handlingCostRate": 0,
    "isHandlingCostLumpsum": false,
    "cargo": {
        "self": "http://localhost:8080/ws/rest/Cargo/1104807",
        "key": 1104807
    },
    "createdDate": "2012-10-01T10:52:37",
    "modifiedDate": "2012-10-01T16:09:01",
    "isBlActive": false,
    "hcMeasurement": {
        "measurementCode": "MT",
        "key": 1000578,
        "self": "http://localhost:8080/ws/rest/Measurement/1000578"
    },
    "variousCost": 0,
    "variousRevenue": 0,
    "demurrage": 0,
    "despatch": 0,
    "freight": 0,
    "handlingCost": 0,
    "exporter": null,
    "receiver": null,
    "terminal": null,
    "laytimeUsed": 0,
    "isDemurrageFixed": false,
    "isDespatchFixed": false,
    "laytimeAllowed": 0,
    "laytimeExpireDate": null,
    "laytimeUsedFromDate": null,
    "laytimeUsedToDate": null,
    "outturnQuantity": 0,
    "shipFigure": 0,
    "timeNotToCount": 0,
    "timeOnDemurrage": 0,
    "volume": 0,
    "weight": 1000,
    "tcRateIndex": null,
    "transshipmentVessel": null,
    "laytimeCounterpart": null,
    "isCargoQuantityFixed": false,
    "isFreeDespatch": false,
    "isLaytimeProrated": false,
    "isWorking": true,
    "laytimeQuantity": 0,
    "onDockQuantity": 0,
    "pctOfLaytimeUsed": 0,
    "reversibleMatch": "1",
    "remarks": [],
    "self": "http://localhost:8080/ws/rest/CargoPort/1104810",
    "key": 1104810,
    "handlingCostCurrency": {
        "currencyCode": "EUR",
        "currencyName": "Euro",
        "key": 400008,
        "self": "http://localhost:8080/ws/rest/Currency/400008"
    },
    "handlingCostCurrencyAmount": 0,
    "demurrageTimeBarEvent": {
   		 "key": 1000052,
	    "self": "http://localhost:8080/ws/rest/Event/1000052",
    	"eventCode": "DEP",
	    "eventDesc": "Departed"
    },
    "notToCounts": [
        {
            "key": 3987343,
            "self": "http://localhost:8080/ws/rest/NotToCount/3987343",
            "minutesNotToCount": 100,
        }
    ]
}

Top
Back

Unknown macro: {dynamiccontentbylabel}

Short Description

Long Description

Properties

Example Response Body

Related Content