Welcome to the Veson Nautical Knowledge Base. In the Help Center, you can view the same articles and contact support as needed.
Entity Service
- Laura Packard
get /v3/entities/commodities
(listCommodities)
ListCommodities retrives all commodities
Return type
Example data
Content-Type: application/json
{
"commodities" : [ {
"commodityGroup" : "commodityGroup",
"commodity" : "commodity",
"commodityValue" : "commodityValue",
"commodityId" : 0,
"platform" : "platform"
}, {
"commodityGroup" : "commodityGroup",
"commodity" : "commodity",
"commodityValue" : "commodityValue",
"commodityId" : 0,
"platform" : "platform"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListCommoditiesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/countries
(listCountries)
ListCountries retrives all countries
Return type
Example data
Content-Type: application/json
{
"countries" : [ {
"country" : "country",
"countryCode" : "countryCode"
}, {
"country" : "country",
"countryCode" : "countryCode"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListCountriesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/ports
(listPorts)
ListPorts retrieves all ports
Return type
Example data
Content-Type: application/json
{
"ports" : [ {
"unlocode" : "unlocode",
"unlocodeAlias" : [ "unlocodeAlias", "unlocodeAlias" ],
"countryCode" : "countryCode",
"portName" : "portName",
"portId" : 0,
"region" : "region",
"portNameAlias" : [ "portNameAlias", "portNameAlias" ]
}, {
"unlocode" : "unlocode",
"unlocodeAlias" : [ "unlocodeAlias", "unlocodeAlias" ],
"countryCode" : "countryCode",
"portName" : "portName",
"portId" : 0,
"region" : "region",
"portNameAlias" : [ "portNameAlias", "portNameAlias" ]
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListPortsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/regions
(listRegions)
ListRegions retrives all regions
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"regionId" : "regionId",
"regionName" : "regionName"
}, {
"regionId" : "regionId",
"regionName" : "regionName"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListRegionsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/regionswithpolygons
(listRegionsWithPolygons)
ListRegionsWithPolygons retrives all regions with geo polygons
Return type
v3ListRegionsWithPolygonResponse
Example data
Content-Type: application/json
{
"regions" : [ {
"geojson" : "geojson",
"regionId" : "regionId",
"regionName" : "regionName"
}, {
"geojson" : "geojson",
"regionId" : "regionId",
"regionName" : "regionName"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListRegionsWithPolygonResponse
default
An unexpected error response. rpcStatus
get /v3/entities/segments
(listSegments)
ListSegments retrieves all available vessel segments
Return type
Example data
Content-Type: application/json
{
"segments" : [ {
"highlevelType" : "highlevelType",
"segment" : "segment",
"segmentKey" : "segmentKey",
"subSegment" : "subSegment",
"segmentInt" : 0,
"cutoffHigh" : 5.962133916683182,
"subSegmentInt" : 6,
"subSegmentKey" : "subSegmentKey",
"cutoffLow" : 1.4658129805029452,
"platform" : "platform"
}, {
"highlevelType" : "highlevelType",
"segment" : "segment",
"segmentKey" : "segmentKey",
"subSegment" : "subSegment",
"segmentInt" : 0,
"cutoffHigh" : 5.962133916683182,
"subSegmentInt" : 6,
"subSegmentKey" : "subSegmentKey",
"cutoffLow" : 1.4658129805029452,
"platform" : "platform"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListSegmentsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/zones
(listZones)
ListZones retrieves all zones
Return type
Example data
Content-Type: application/json
{
"zones" : [ {
"zoneId" : 0,
"zoneName" : "zoneName"
}, {
"zoneId" : 0,
"zoneName" : "zoneName"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListTonnageZonesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/zoneswithpolygon
(listZonesWithPolygons)
ListZonesWithPolygons retrieves all zones with Polygons
Return type
v3ListTonnageZonesWithPolygonsResponse
Example data
Content-Type: application/json
{
"zones" : [ {
"geomPolygonWkt" : "geomPolygonWkt",
"zoneId" : 0,
"geomCoordinateGeojson" : "geomCoordinateGeojson",
"zoneName" : "zoneName",
"zoneBasin" : "zoneBasin",
"geomPolygonGeojson" : "geomPolygonGeojson",
"geomCoordinateWkt" : "geomCoordinateWkt"
}, {
"geomPolygonWkt" : "geomPolygonWkt",
"zoneId" : 0,
"geomCoordinateGeojson" : "geomCoordinateGeojson",
"zoneName" : "zoneName",
"zoneBasin" : "zoneBasin",
"geomPolygonGeojson" : "geomPolygonGeojson",
"geomCoordinateWkt" : "geomCoordinateWkt"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3ListTonnageZonesWithPolygonsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/polygons/search
(searchPolygons)
Query parameters
q (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"polygons" : [ {
"unlocode" : "unlocode",
"berthId" : 0,
"countryCode" : "countryCode",
"entityType" : "entityType",
"alias" : "alias",
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName"
}, {
"unlocode" : "unlocode",
"berthId" : 0,
"countryCode" : "countryCode",
"entityType" : "entityType",
"alias" : "alias",
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3SearchPolygonsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/vessels/search
(searchVessels)
Query parameters
q (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"vessels" : [ {
"dwt" : 6.027456183070403,
"beam" : 2.3021358869347655,
"highlevelType" : "highlevelType",
"built" : 5,
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 0,
"type" : "type",
"holdsTotal" : 7.061401241503109,
"mpv" : true,
"maxDraught" : 1.4658129805029452,
"segment" : "segment",
"name" : "name",
"loa" : 5.637376656633329
}, {
"dwt" : 6.027456183070403,
"beam" : 2.3021358869347655,
"highlevelType" : "highlevelType",
"built" : 5,
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 0,
"type" : "type",
"holdsTotal" : 7.061401241503109,
"mpv" : true,
"maxDraught" : 1.4658129805029452,
"segment" : "segment",
"name" : "name",
"loa" : 5.637376656633329
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3SearchVesselsResponse
default
An unexpected error response. rpcStatus
Still need help? Visit the Veson Nautical Help Center.
Copyright © 2017-2024 Veson Nautical LLC All Rights Reserved - Privacy Notice | End User Terms of Use