Versions Compared

Key

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

Short Description

StatusType is used in several entities. Note that when setting StatusType it must be of the correct StatusClass or it will be denied. The correct StatusClass can be identified by the name of the property, i.e. Voyage has a voyageStatus property, which corresponds to the "Voyage status" StatusClass, and Cargo has a bookingStatus property, which corresponds to the "Booking status" StatusClass. 

Chapter Contents:

Table of Contents
maxLevel4
minLevel4

Long Description

Properties

Property
Type
Length
Mandatory
Description
Comments
isFixed
Boolean    
statusClass
/StatusClass    
statusTypeCode
String 5 Yes  
statusTypeDesc
String 20 Yes  
statusTypeSequence
Integer 22   

Example

...

Response Body

Note
This example has been updated for API version

Updated for API version 2.0.0

using date format

using the new required date format yyyy-dd-MMThh:mi:ss

, versions prior to 2.0.0 has the following date format:

to conform ISO 8601, (prior version has date format: yyyy-dd-MM

hh:mi:ss)

Code Block
languagejs
{
    "key": 1000094,
    "self": "http://localhost:8080/ws/rest/StatusType/1000094",
    "createdDate": "2004-04-29T17:02:21",
    "modifiedDate": "2004-07-17T21:02:41",
    "isFixed": true,
    "statusTypeCode": "RFP",
    "statusTypeDesc": "Ready for posting",
    "statusTypeSequence": 25,
    "statusClass": {
        "key": 1000090,
        "self": "http://localhost:8080/ws/rest/StatusClass/1000090",
        "statusClassCode": "INV",
        "statusClassDesc": "Invoicing status"
    },
    "remarks": []
}

Top
Back