Versions Compared

Key

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

...

Up

get /v3/entities/commodities

(listCommodities)

ListCommodities retrives all commodities

Return type

v3ListCommoditiesResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListCommoditiesResponse

default

An unexpected error response. rpcStatus

Anchor
listCountries
listCountries

Up

get /v3/entities/countries

...

ListCountries retrives all countries

Return type

v3ListCountriesResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListCountriesResponse

default

An unexpected error response. rpcStatus

Anchor
listPorts
listPorts

Up

get /v3/entities/ports

(listPorts)

ListPorts retrieves all ports

Return type

v3ListPortsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListPortsResponse

default

An unexpected error response. rpcStatus

Anchor
listRegions
listRegions

Up

get /v3/entities/regions

(listRegions)

ListRegions retrives all regions

Return type

v3ListRegionsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListRegionsResponse

default

An unexpected error response. rpcStatus

Anchor
listRegionsWithPolygons
listRegionsWithPolygons

Up

get /v3/entities/regionswithpolygons

...

ListRegionsWithPolygons retrives all regions with geo polygons

Return type

v3ListRegionsWithPolygonResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListRegionsWithPolygonResponse

default

An unexpected error response. rpcStatus

Anchor
listSegments
listSegments

Up

get /v3/entities/segments

...

ListSegments retrieves all available vessel segments

Return type

v3ListSegmentsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListSegmentsResponse

default

An unexpected error response. rpcStatus

Anchor
listZones
listZones

Up

get /v3/entities/zones

(listZones)

ListZones retrieves all zones

Return type

v3ListTonnageZonesResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListTonnageZonesResponse

default

An unexpected error response. rpcStatus

Anchor
listZonesWithPolygons
listZonesWithPolygons

Up

get /v3/entities/zoneswithpolygon

...

ListZonesWithPolygons retrieves all zones with Polygons

Return type

v3ListTonnageZonesWithPolygonsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3ListTonnageZonesWithPolygonsResponse

default

An unexpected error response. rpcStatus

Anchor
searchPolygons
searchPolygons

Up

get /v3/entities/polygons/search

...

Query Parameter —

Return type

v3SearchPolygonsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3SearchPolygonsResponse

default

An unexpected error response. rpcStatus

Anchor
searchVessels
searchVessels

Up

get /v3/entities/vessels/search

...

Query Parameter —

Return type

v3SearchVesselsResponse

Example data

Content-Type: application/json

...

200

A successful response. v3SearchVesselsResponse

default

An unexpected error response. rpcStatus