ABB
API docs by Redocly

Shipping Weather Services (1.3616.0)

Download OpenAPI specification:

ABB customer service: support.voyageoptimization@abb.com URL: https://new.abb.com/marine/systems-and-solutions/digital/routing-services

The Shipping Weather Services handle the triggering, creation, and retrieval of marine weather, which are stored in SPS files.

Authentication

Get a token

Get token for use in HTTP requests.

Request Body schema: application/x-www-form-urlencoded
client_id
required
string

Client ID as provided by ABB

client_secret
required
string

Client secret as provided by ABB

grant_type
required
string
Default: "client_credentials"

The type of token request

scope
required
string

The scope the credentials should belong to.

Responses

Response Schema: application/json
access_token
required
string

The token that should be used in all requests to the API

expires_in
required
integer

The amount of time the token is valid [ s ]

scope
required
string

A space-delimited list of the scopes of the token

token_type
required
string
Default: "Bearer"

The type of token

resource
string

Resource associated to the token

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "token_type": "Bearer",
  • "scope": "string",
  • "resource": "string"
}

Marine Weather

Operations for retrieval of marine weather SPS files.

Health Check

The health check endpoint provides information about the health of a web service. If each of the components required by the service are healthy, then the service is considered healthy and will return a 200 OK response. If any of the components needed by the service are unhealthy, then a 503 Service Unavailable response will be provided.

Responses

Response Schema: application/json
status
required
string
env
string
info
string
timestamp
string <RFC 3339 (UTC)>
version
string

Response samples

Content type
application/json
{
  • "status": "up",
  • "version": "1.3616.0",
  • "info": "Service is healthy.",
  • "timestamp": "2018-02-10T09:30:00Z",
  • "env": "dev"
}

Available Issues

Get the available weather forecast issues.

query Parameters
from
string <RFC 3339 (UTC)>
Example: from=2024-01-01T00:00:00.000Z

Date & Time from which the data is requested. If time range is not provided, the available issues for the last 31 days will be returned.

onlyLatest
boolean
Example: onlyLatest=true

If set to true, only the latest weather forecast issue time will be returned. Default: false

onlyWithAnalysis
boolean
Example: onlyWithAnalysis=true

If set to true, only the weather forecast issues with analysis will be returned. Default: false

to
string <RFC 3339 (UTC)>
Example: to=2024-01-01T00:00:00.000Z

Date & Time until which the data is requested. If time range is not provided, the available issues for the last 31 days will be returned.

Responses

Response Schema: application/json
apiVersion
required
string

Version of the API this response was generated from

required
Array of objects non-empty

The available issue times of the weather forecast

correlationId
required
string

Internal identifier of the request

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "apiVersion": "1.3616.0",
  • "availableIssues": [
    ]
}

Issue Details

Get the details of the requested issues.

query Parameters
issueTime
required
string <RFC 3339 (UTC)>
Example: issueTime=2024-01-01T00:00:00.000Z

The issue time of the weather forecast

onlyAnalysis
boolean
Example: onlyAnalysis=true

If set to true, only the details of issues containing analysis will be returned. If set to false or not provided, all issue details will be returned. Default: false

Responses

Response Schema: application/json
apiVersion
required
string

Version of the API this response was generated from

correlationId
required
string

Internal identifier of the request

required
Array of objects non-empty

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "apiVersion": "1.3616.0",
  • "details": [
    ]
}