Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated API Properties

Short Description

Note
 Port is a readRead-only resourceOnly Resource.

Chapter Contents:

Table of Contents
maxLevel4
minLevel4

...

Get a single Port object.

Properties

Property
Type
Length
Mandatory
Description
Comments
portNameString20
 Yes  


unLoCodeStringN/A
   
country
/Country Yes  
isCanal
Boolean    
itdsCode
String6   
locationCode
String3   
rpCode
String2   
wpiCode
Integer    
timezone
/Timezone Yes  


country/Country


isCanalBoolean


itdsCodeString6

locationCodeString3

rpCodeString2

wpiCodeInteger


timezone/Timezone


terminalsArray of /Terminal


businessPartnersArray of /BusinessPartner


portAreaArray of /PortArea


portRef936706049

from API 3.14.0
timezoneOffsetDouble
Offset from GMTfrom API 6.5.0
isOpenLoopRestrictedBoolean


longitudeDoubleN/Aport coordinates
latitudeDoubleN/A

port coordinates


bunkerCategoryAe/BunkerCategory


bunkerCategoryMe/BunkerCategory


zoomLevelInteger


portAreasArray of /PortArea



Example Response Body

Note

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)


Code Block

...

{
    "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

Related Content

Expand
titleExpand to see related content


Wiki Markup
{dynamiccontentbylabel:showLabels=false|showSpace=false}