Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Short Description

...

If it is needed to be stored in NotToCount the CargoPort key but the known data are the Voyage key, the port name, the reasonForCall and the terminal code, can be used the following endpoint:

/ws/rest/CargoPort?filter=cargo.voyage.portCalls.ownedByVoyage(EQ){VOYAGE_KEY}&filter=port.portName(EQ){PORT_NAME}&filter=reasonForCall.reasonForCall(EQ){REASON_FOR_CALL_CODE}&filter=terminal.terminalCode(EQ){TERMINAL_CODE}

One example of endpoint:

/ws/rest/CargoPort?filter=cargo.voyage.portCalls.ownedByVoyage(EQ)318636143&filter=port.portName(EQ)ZHUHAI&filter=reasonForCall.reasonForCall(EQ)D&filter=terminal.terminalCode(EQ)CNZUH-0008

that returns an array of just one element of CargoPort with just its key that can be used to be stored in NoToCount:

Code Block
languagejs
[
    {
        "remarks": [],
        "key": 318636167,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/CargoPort/318636167"
    }
]

...

Property
Type
Length
Mandatory
Description
Comments
daysNotToCount
Double

Number of days to not count
isProrated
Boolean



notToCountStartDate
Date

Period start date
notToCountEndDate
Date

Period end date
percentToCount
Double

Percent to not count
reasonForDelayString64
Reason for delay description
sourceInteger
YesFrom API 3.22 it can be or a /CargoPort or a /PortCall key 
minutesNotToCountInteger



portCall/PortCall

Connected PortCall, if any


New NotToCount Example

Example how to insert a new NotToCount object

...

Code Block
languagejs
{
  "key": 1030703,
  "self": "http://platform-dev.dataloy.com:80/ws/rest/NotToCount/1030703",
  "createdDate": "2004-08-27T00:21:30",
  "modifiedDate": "2004-10-14T00:18:07",
  "createdById": 1000004,
  "source": 1030702,
  "percentToCount": 50,
  "daysNotToCount": 0.01216,
  "isProrated": false,
  "notToCountEndDate": "2004-07-10T13:50:00",
  "notToCountStartDate": "2004-07-10T13:15:00",
  "reasonForDelay": "H6 ONLY",
  "remarks": [],
  "isObjectActive": true
}

...