Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Short Description

NotToCount resource stores all the time used which is “not to count” in the penalty (demurrage) calculation. It can be connected, though 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)318636143&filter=port.portName(EQ)ZHUHAI&filter=reasonForCall.reasonForCall(EQ)D&filter=terminal.terminalCode(EQ)CNZUH-0008


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
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
Yescan be or a /CargoPort or a /PortCall key 

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: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
}
  • No labels