Overview

본 문서는 선박의 Event, Template, 선종, 사용 기기 설정 등에 따라
Noon Data API Response의 필드 구성이 달라지는 구조를 이해하는 데 도움을 주기 위해 작성되었습니다.

This document is intended to help users understand why the field structure of the Noon Data API response varies depending on the vessel’s event, template configuration, ship type, and onboard equipment settings.

---

Vessellink Event List

Vessellink는 환경 규제 대응을 위해 총 22개의 이벤트로 구성되어 있으며, 선박의 실제 운항 및 작업 흐름에 맞게 작성될 수 있도록 이벤트 플로우 정책을 적용하고 있습니다.

• EVENT KEY는 API Response의 "EVENT_KEY" 값이며,
• EVENT NAME은 Vessellink 시스템 내 표시되는 이벤트 명칭입니다.

Vessellink For Ship에 입력하는 필드는 이벤트별로 상이하며, 이에 따라 Noon Data API의 필드 구성 또한 이벤트에 따라 달라집니다.

Vessellink consists of a total of 22 events designed to support environmental regulation compliance.
These events are defined based on the vessel’s actual operational and work flow and follow an established event flow policy.

• EVENT KEY corresponds to the value of "EVENT_KEY" in the API response.
• EVENT NAME represents the event name displayed within the Vessellink system.

Since the input fields in Vessellink For Ship differ by event, the field structure of the Noon Data API response also varies depending on the event.

Initial Setup Event의 경우, Vessellink 사용을 위한 초기 세팅 이벤트 이므로 API 응답값에서는 제공되지 않습니다.

The Initial Setup event is used only for initial system configuration in Vessellink and is therefore not included in the API response.

---

Vessellink Template Concept

Vessellink Event Template은 선박에서 사용하는 Vessellink For Ship 프로그램의 이벤트별 작성 양식을 뜻합니다.

Template은 선박의 선종, Engine Type, Dual Fuel 사용 여부 등 아래 설정 항목에 따라 구성이 상이합니다.

1)~4) 까지의 Setting을 완료하면 최종 Template이 생성되어 선박에 배포되며, 이를 통해 Vessellink 리포트를 작성할 수 있습니다.

A Vessellink Event Template refers to the event-specific reporting form used in the Vessellink For Ship application onboard vessels.

The template structure varies depending on the vessel’s configuration settings, such as ship type, engine type, and dual fuel usage, as described below.

Once settings 1) through 4) are completed, a final template is generated and deployed to the vessel, enabling report creation through Vessellink.

1) Based Template

Event별로 입력하고자 하는 기본 Field 정보를 포함한 Template을 선택합니다.

이 단계에서 선택하는 Template은 선사 단위로 관리하고자 하는 데이터가 다양하므로 선사별로 커스터마이징된 Template을 적용합니다.

또한 동일 선사 안에서도 특정 선종의 경우 추가로 입력 해야할 필드가 존재하는 경우가 있어, 특정 선종을 위한 Template을 선택하게 됩니다.

A base template containing the default set of input fields for each event is selected.

Since the data required to be managed may vary by shipping company, company-specific customized templates can be applied.
In addition, even within the same company, certain ship types may require additional input fields, in which case a ship-type-specific template is selected.

2) Ship Type

선박의 선종을 선택합니다.

선종에 따라 Vessellink의 Cargo Work 이벤트의 필드 구성이 결정되며, 이에 따라 Noon Data API의 "CARGO_WORK" 이벤트의 "LOADING_CONDITION" 객체 내 필드의 구성도 달라집니다.

The vessel’s ship type is selected.

Depending on the ship type, the field structure of the Cargo Work event in Vessellink is determined.
Accordingly, the field composition within the "LOADING_CONDITION" object of the "CARGO_WORK" event in the Noon Data API response may vary.

3) Engine Type

선박의 Engine Type을 선택할 수 있으며, 이에 따라 F.O 및 L.O Items를 선택할 수 있습니다.

The vessel’s engine type is selected, which determines the available F.O and L.O items.

(1) F.O Items

Engine Type에 따라 각종 기기의 대수에 맞춰 F.O Items를 활성화 할 수 있으며,
Vessellink 리포트 내 기기별 연료유 소모량 및 ROB 테이블의 구성이 결정됩니다.
이에 따라 Noon Data API의 "ROB"와 "OIL_CONSUMPTION" 객체 내 필드 구성이 상이합니다.

Based on the engine type, F.O items can be activated according to the number of installed devices.
This configuration determines the structure of fuel consumption and ROB tables in Vessellink reports.

As a result, the field composition of the "ROB" and "OIL_CONSUMPTION" objects in the Noon Data API response may differ.

(2) L.O Items

Engine Type에 따라 사용하는 L.O를 활성화 할 수 있으며, Vessellink 내 L.O 소모량 및 ROB 테이블의 구성이 결정됩니다.
이에 따라 Noon Data API의 "ROB"와 "OIL_CONSUMPTION" 객체 내 필드 구성이 달라집니다.

Depending on the engine type, the L.O items in use can be activated.
This configuration determines the structure of L.O consumption and ROB tables in Vessellink reports.

Accordingly, the field composition of the "ROB" and "OIL_CONSUMPTION" objects in the Noon Data API response may vary.

4) Dual Fuel

선박이 사용하는 Dual Fuel을 선택합니다.

F.O 외 LNG, PROPANE, BUTANE, METHANOL, ETHANOL, BOG 를 연료로 사용하는 경우 설정할 수 있으며, 이에 따라 Vessellink 내 기기별 연료유 소모량 및 ROB 테이블의 구성이 결정됩니다.
따라서 Noon Data API의 "ROB"와 "OIL_CONSUMPTION" 객체 내 필드 구성도 달라집니다.

The vessel’s dual fuel configuration is selected.

In addition to F.O, fuels such as LNG, PROPANE, BUTANE, METHANOL, ETHANOL, and BOG can be configured.
This setting determines the structure of device-level fuel consumption and ROB tables in Vessellink.

As a result, the field composition of the "ROB" and "OIL_CONSUMPTION" objects in the Noon Data API response also varies.

API Response Structure

정리하면, Noon Data API의 Response는 고정된 단일 스키마가 아닌 Event와 개별 선박에 Template 설정에 따라 동적으로 구성됩니다.

동일한 Event라 하더라도 선사별 기본 템플릿 설정, 선박의 선종, Engine Type, 사용하는 연료 구성 등 Template 설정에 따라 Response 필드 구성이 달라질 수 있습니다.

전체 필드 정의 등 상세 내용은 별도 문서를 통해 제공하고 있으므로 필요 시 Vessellink 팀으로 문의해 주시기 바랍니다.

In summary, the Noon Data API response is not based on a single fixed schema, but is dynamically structured according to the event and the template configuration applied to each vessel.

Even for the same event, the response field structure may vary depending on factors such as the company’s base template, vessel ship type, engine type, and fuel configuration.

Detailed information, including the complete field definitions, is provided in a separate document.
If you require access to this document, please contact the Vessellink team.

(Email: [email protected])