Description

The SHIPHarbour API ultimately only allows transmission of one type of message which is called a Generic message. This message type holds required fields of all messages as well as holding all possible message payloads.

Message Fields

version

Must be set to the VersionCode of the protocol currently being used.

error

Must be set to NONE when sending a new request to SHIPHarbour Master. Any response messages will have this field set to the most descriptive ErrorCode if a request fails.

payload

Holds exactly one of the following types:

• open – These messages are used to establish a new connection between SHIPHarbour Master and a client.
• close – These messages are used to terminate an active connection with SHIPHarbour Master.
• pluginInfo – These messages are sent spontaneously by SHIPHarbour Master in order to notify clients of available communications interfaces.
• moduleInfo – These messages are sent spontaneously by SHIPHarbour Master in order to notify clients of connections and disconnections of Endpoints.
• routine – All requests that are directly targeted at interacting with a Serious Integrated module are encapsulated in this message type.