/Port

Short Description

Port is a Read-Only Resource.

Chapter Contents:

Long Description

Supported Methods

GET /Port

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

GET /Port/{key}

Get a single Port object.

Properties

Property	Type	Length	Description	Comments
portName	String	20
unLoCode	String	N/A
country	/Country
isCanal	Boolean
itdsCode	String	6
locationCode	String	3
rpCode	String	2
wpiCode	Integer
timezone	/Timezone
terminals	Array of /Terminal
businessPartners	Array of /BusinessPartner
portArea	Array of /PortArea
portRef	/Port			from API 3.14.0
timezoneOffset	Double		Offset from GMT	from API 6.5.0
isOpenLoopRestricted	Boolean

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)

{
    "portName": "BERGEN",
    "unLoCode": "NOBGO",
    "country": {
        "countryCode": "NO",
        "countryName": "NORWAY",
        "key": 410154,
        "self": "http://localhost:8080/ws/rest/Country/410154"
    },
    "isCanal": false,
    "createdDate": "2004-04-29T16:55:08",
    "modifiedDate": "2014-01-27T02:53:47",
    "itdsCode": "40311",
    "locationCode": "BGO",
    "rpCode": null,
    "wpiCode": null,
    "timezone": {
        "key": 133966,
        "self": "http://localhost:8080/ws/rest/Timezone/133966",
        "timezoneName": "Europe/Oslo"
    },
    "remarks": [],
    "self": "http://localhost:8080/ws/rest/Port/104146",
    "key": 104146
}

Top
Back