NYSHEX External OpenAPI specification (1.0.0)

Download OpenAPI specification:Download

New York Shipping Exchange (NYSHEX): info@NYSHEX.com URL: https://nyshex.com/ License: Apache 2.0

This API provides external access to NYSHEX data. It allows users to create, read, and update information regarding bookings, contracts, statements, disputes, and other relevant data.

Health

Current running version of the microservice

Returns the current version of the microservice.

Security
Responses
200

Service version returned

get/version
Request samples 
Response samples 
application/json
{
  • "group": "string",
  • "artifact": "string",
  • "name": "string",
  • "version": "string",
  • "time": { }
}
Ping service
Checks for connectivity to the service by sending a ping and receiving a response in return.


Security 
Responses 
200
Ping returned


get/ping.txt
Request samples 
Response samples 
application/json
"string"