API docs by Redocly

Location service. (1.0.0)

Download OpenAPI specification:

License: MIT

API for the location service.

NationalBerth

Fetches GISIS codes related to the given LOCODE. If no LOCODE is supplied then all available GISIS codes are returned.

Fetches GISIS codes related to the given LOCODE. If no LOCODE is supplied then all available GISIS codes are returned.

Authorizations:
bearerAuth
query Parameters
locode
string

The LOCODE of the port where the GISIS berths are.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Fetches finnish port information from the db with port area code. If code is not provided then all berths are returned.

Fetches finnish port information from the db with port area code.

Authorizations:
bearerAuth
query Parameters
portAreaName
string

The finnish port area code eg. FIHEL-ES.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches finnish berth information from the db with gisisCode.

Fetches finnish berth information from the db with gisisCode.

Authorizations:
bearerAuth
query Parameters
gisis
string

The gisisCode of the finnish berth.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches finnish port information from the db.

Fetches finnish port information from the db.

Authorizations:
bearerAuth
path Parameters
code
required
string

The finnish port berth code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NationalPortArea

Fetches finnish port areas from the db with locode. If locode is not provided then all port areas are returned.

Fetches finnish port areas from the db with locode. If locode is not provided then all port areas are returned.

Authorizations:
bearerAuth
query Parameters
locode
string

The locode of the finnish port.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Location

Fetches location data from the db. If request body is empty then a limited default list of location items is returned.

Fetches location data from the db. If request body is empty then a limited default list of location items is returned.

Authorizations:
bearerAuth
Request Body schema: application/json
optional
stringSearch
string or null

A general string search param. Is matched against locode and location name.

Responses

Request samples

Content type
application/json
{
  • "stringSearch": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Fetches only LOCODE values from the db. If no LOCODE filter is supplied then all available LOCODE values are returned.

Fetches only LOCODE values from the db. If no LOCODE filter is supplied then all available LOCODE values are returned.

Authorizations:
bearerAuth
query Parameters
locode
string

Optional LOCODE filter. Matching is case-insensitive and uses LOCODE values only.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Checks if locode exists in db.

Checks if locode exists in db.

Authorizations:
bearerAuth
query Parameters
locode
required
string

Locode to check.

Responses

Response samples

Content type
application/json
true