/NotToCount

Short Description

NotToCount resource stores all the time used which is “not to count” in the penalty (demurrage) calculation. It can be connected, through the source attribute, either to a CargoPort or a PortCall object.

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:

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

Chapter Contents:

Long Description

Supported Methods

GET /NotToCount

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

GET /NotToCount/{key}

Get a single NotToCount object specified by its key.

POST /NotToCount
Insert a new NotToCount object:

PUT /NotToCount/{key}

Update an existing NotToCount .

DELETE /NotToCount/{key}

Delete the specified NotToCount object.

Properties

Property	Type	Length	Mandatory	Description
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
reasonForDelay	String	64		Reason for delay description
source	Integer		Yes	From API 3.22 it can be or a /CargoPort or a /PortCall key
minutesNotToCount	Integer
portCall	/PortCall			Connected PortCall, if any

New NotToCount Example

Example how to insert a new NotToCount object

POST /NotToCount

Request Body:

{
  
  "source": 1030702,
  "percentToCount": 50,
  "daysNotToCount": 0.01216,
  "isProrated": false,
  "notToCountEndDate": "2004-07-10T13:50:00",
  "notToCountStartDate": "2004-07-10T13:15:00",
  "reasonForDelay": "H6 ONLY"
}

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)

{
  "key": 1030703,
  "self": "http://platform-dev.dataloy.com/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
}