/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
longitude	Double	N/A	port coordinates
latitude	Double	N/A	port coordinates
bunkerCategoryAe	/BunkerCategory
bunkerCategoryMe	/BunkerCategory
zoomLevel	Integer
portAreas	Array of /PortArea

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": "https://platform-dev.dataloy.com:9143/ws/rest/Country/410154"
    },
    "isCanal": false,
    "timezoneOffset": 1.0,
    "createdDate": "2004-04-29T16:55:08",
    "createdById": 999999,
    "externalObjectKey": null,
    "modifiedDate": "2017-09-01T10:03:04",
    "latitude": 60.392039,
    "longitude": 5.306605,
    "portAreas": [
        {
            "key": 3940368,
            "self": "https://platform-dev.dataloy.com:9143/ws/rest/PortArea/3940368"
        },
        {
            "key": 3951021,
            "self": "https://platform-dev.dataloy.com:9143/ws/rest/PortArea/3951021"
        },
        {
            "key": 3929718,
            "self": "https://platform-dev.dataloy.com:9143/ws/rest/PortArea/3929718"
        },
        {
            "key": 3961671,
            "self": "https://platform-dev.dataloy.com:9143/ws/rest/PortArea/3961671"
        }
    ],
    "locationCode": "BGO",
    "isOpenLoopRestricted": false,
    "itdsCode": "40311",
    "rpCode": null,
    "wpiCode": null,
    "zoomLevel": 3,
    "bunkerCategoryAe": {
        "key": 916947,
        "self": "https://platform-dev.dataloy.com:9143/ws/rest/BunkerCategory/916947"
    },
    "bunkerCategoryMe": {
        "key": 916947,
        "self": "https://platform-dev.dataloy.com:9143/ws/rest/BunkerCategory/916947"
    },
    "businessPartners": [],
    "portRef": null,
    "timezone": {
        "key": 133966,
        "self": "https://platform-dev.dataloy.com:9143/ws/rest/Timezone/133966",
        "timezoneName": "Europe/Oslo",
        "tzPeriods": [..]
    },
    "remarks": [],
    "isObjectActive": true,
    "key": 104146,
    "self": "https://platform-dev.dataloy.com:9143/ws/rest/Port/104146"
}

Top
Back

Dataloy API