Location service. (1.0.0)

Download OpenAPI specification:

License: MIT

API for the location service.

Location

Fetches location data from the db. If request body is empty then all location items are returned.

Authorizations:

None

Request Body schema: application/json
optional

stringSearch

string

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

Responses

Request samples

Payload

Content type

application/json

{"stringSearch": "string"
}

Response samples

200

Content type

application/json

[{"locode": "string",
"createdOn": null,
"lastUpdatedOn": null,
"locationNameWithDiacritics": "string",
"locationNameWithoutDiacritics": "string",
"countryCode": "string",
"type": 0,
"coordinates": {"latitude": null,
"longitude": null
},
"UNECEFunctions": ["string"
],
"portFacilities": [{"name": "string",
"description": "string",
"code": "string",
"coordinates": {"latitude": null,
"longitude": null
}
}
]
}
]

Checks if locode exists in db.

Authorizations:

None

query Parameters

locode

required

string

Locode to check.

Responses

Response samples

200

Content type

application/json

true

Location service. (1.0.0)

Location

Fetches location data from the db. If request body is empty then all location items are returned.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Checks if locode exists in db.

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
optional