All Collections
API
Vessel Health Check Submission API
Vessel Health Check Submission API
Updated over a week ago

All APIs require authentication, which is delegated to Auth0. Before any of the following external APIs can be accessed, the requestor needs to authenticate using a client id and client secret. The returned bearer token is then added to the request headers.

Screen APIs

The Screen APIs allow access to Trade Check, Pre-Arrival Check and Vessel Health Check submissions, as well as request their status.

Usage

To use the Screen APIs, an account is required to obtain an Access Token by authenticating. All requests must be formatted as JSON and contain the following headers:

Header Name

Header Value

Optional

Comments

Authorization

Bearer <access-token>

false

Content-Type

application/json

false

Each response will have the following structure, where data field will contain the actual data payload.

Property Name

Property Type

Can be Empty

Success

bool

false

ErrorMessage

String?

true

Data

Payload Data Type

tru

Example response including data:

{

"success": true,

"errorMessage": null,

"data": {

"uniqueIdentifier": "c91cd0bd-cf61-46fb-91bc-b6ba1a9af3a0"

}

}

Response Codes

Http Response Code

Description

200

Successful

400

Bad Request – Missing/invalid input parameters

401

Unauthenticated – the authentication access token is missing or expired

403

Unauthorized – the user is logged in successfully, however does not have permission to access the requested resource.

500

Unexpected error – please contact support along with any returned error messages

Submit Vessel Health Check

Create a new vessel health check. Vessel health check will be created for the user associated to the client access token.

Request Uri: [HttpPost] /api/vesselhealthcheck/v1

Request:

Property Name

Property Type

Optional

Comments

VesselIMO

string

false

Vessel International Maritime Organization Number

RequestedOnBehalfOfCompanyName

string?

true

Create vessel health check on behalf of another company

RequestedOnBehalfOfName

string?

true

Create vessel health check on behalf of another company

RequestedOnBehalfOfEmail

string?

true

Create vessel health check on behalf of another company

IsConfirmed

bool

false

Is vessel health check confirmed

Response:

Property Name

Property Type

Can Be Empty

Comments

UniqueIdentifier

String?

True

If the vessel health check creation request was successful, this will contain an unique identifier for the new submission

Notes:

- Any fields in the request body which are marked with a ‘?’ are optional.

- When the vessel health check request is submitted, the creation part of the submission is queued. The uniqueIdentifier in the response can be used to query the vessel health check creation status by calling the Get VesselHealthCheck Status API.

Get Vessel Health Check Status

Get the creation status of a previously created Vessel Health Check.

Request Uri: [HttpGet] /api/vesselhealthcheck/v1/{UniqueCode}

Request: empty

Response:

Property Name

Property Type

Can Be Empty

UniqueIdentifier

string

false

OutcomeSummary

string

false

OutcomeDescription

String

false

OutcomeTimestamp

datetime?

true

CriticalActionCount

Int

false

CriticalActions

VesselHealthCheckAction[]

true

RequiredActionCount

int

false

RequiredActions

VesselHealthCheckAction[]

true

SuggestedActionCount

Int

false

SuggestedActions

VesselHealthCheckAction[]

true

RiskAnalysisCategories

RiskAnalysisIssueCategory

true

RequestedOnBehalfOfCompanyName

string?

true

RequestedOnBehalfOfName

string?

true

RequestedOnBehalfOfEmail

string?

true

VesselHealthCheckAction:

Property Name

Property Type

Can Be Empty

Comments

Name

string

false

Info

string

false

RiskAnalysisIssueCategory:

Property Name

Property Type

Can Be Empty

Comments

CategoryName

string

false

RiskAnalysisIssuesCount

int

false

RiskAnalysisIssues

RiskAnalysisIssue[]

false

RiskAnalysisIssue:

Property Name

Property Type

Can Be Empty

Comments

Title

string

false

Description

string

false

RiskAnalysisIssues

string

false

Did this answer your question?