Skip to content

Commit f2ab0f9

Browse files
cmsdroffcmsdroff
committed
Added examples for the 'lite' and 'full' notifications to RMO NTF API
1 parent 0c69fbb commit f2ab0f9

1 file changed

Lines changed: 157 additions & 7 deletions

File tree

‎rmo/notification/v1/rmo_ntf_v1.0.0-Beta-1.yaml‎

Lines changed: 157 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ info:
77
description: |
88
API specification issued by DCSA.org.
99
10-
Operational Reefer Monitoring Notifications for [DCSA OpenAPI specification for Operational Reefer Monitoring](https://app.swaggerhub.com/apis/dcsaorg/DCSA_RMO/1.0.0-Beta-1) is a lightweight notification based on [CloudEvents](https://cloudevents.io/).
10+
Reefer Monitoring Operational Notifications for [DCSA OpenAPI specification for Reefer Monitoring Operational](https://app.swaggerhub.com/apis/dcsaorg/DCSA_RMO/1.0.0-Beta-1) is a lightweight notification based on [CloudEvents](https://cloudevents.io/).
1111
The `POST` endpoint of the consumer is called whenever a `Reefer` that is being subscribed to meets the agreed notification criteria.
1212
1313
Subscribing to notification is done outside scope of this API.
1414
1515
### Stats API
16-
The Stats API offers crucial statistical information for both API providers and consumers to enhance their services and helps DCSA to understand and scale the ecosystem. We expect you to invoke the Stats API for every request made to the Operational Reefer Monitoring Notification API. Further details can be found [here](https://developer.dcsa.org/#/http/guides/api-guides/stats-api)
16+
The Stats API offers crucial statistical information for both API providers and consumers to enhance their services and helps DCSA to understand and scale the ecosystem. We expect you to invoke the Stats API for every request made to the Reefer Monitoring Operational Notification API. Further details can be found [here](https://developer.dcsa.org/#/http/guides/api-guides/stats-api)
1717
1818
For a changelog please click [here](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/rmo/notification/v1#v100B1). Please also [create a GitHub issue](https://github.com/dcsaorg/DCSA-OpenAPI/issues/new) if you have any questions/comments.
1919
contact:
@@ -53,7 +53,7 @@ paths:
5353
examples:
5454
alarmActivatedExample:
5555
summary: |
56-
A reefer container with an activated alarm notification
56+
A 'lite' notification for a reefer container with an activated alarm
5757
description: |
5858
A notification that an alarm has been triggered for a reefer container
5959
value:
@@ -65,7 +65,7 @@ paths:
6565
datacontenttype: application/json
6666
data:
6767
notificationType: ALARM
68-
equipmentReference: BICU4812097
68+
equipmentReference: APZU4812090
6969
geoLocation:
7070
latitude: '48.858550'
7171
longitude: '2.294492'
@@ -75,7 +75,7 @@ paths:
7575
alarmSeverity: CRITICAL
7676
deactivedExample:
7777
summary: |
78-
A reefer container with a deactivated alarm notification
78+
A 'lite' notification for a reefer container with a deactivated alarm
7979
description: |
8080
A notification that an alarm has been deactivated for a reefer container
8181
value:
@@ -87,14 +87,164 @@ paths:
8787
datacontenttype: application/json
8888
data:
8989
notificationType: ALARM
90-
equipmentReference: BICU4812097
90+
equipmentReference: APZU4812090
9191
geoLocation:
9292
latitude: '48.858550'
9393
longitude: '2.294492'
9494
alarm:
9595
alarmStatus: INACTIVE
9696
alarmNumber: '100'
9797
alarmSeverity: CRITICAL
98+
heartbeatExample:
99+
summary: "A 'full' notification of the reefer measurements at a point in time"
100+
description: Used to push the full payload to a subscriber for the Reefer Monitoring Operational (RMO) detailing the measurements and settings at point in time.
101+
value:
102+
alarms:
103+
activeAlarmCount: 0
104+
controller:
105+
dateTime: '2023-10-23T15:40:28Z'
106+
hardwareVersion: 1.1.1
107+
maker: '900'
108+
model: N99
109+
operatingState: '1'
110+
serialNumber: '123456789'
111+
softwareVersion: 1.1.1
112+
equipmentReference: APZU4812090
113+
equipmentOptions:
114+
- N00
115+
- N05
116+
geoLocation:
117+
latitude: '48.858550'
118+
longitude: '2.294492'
119+
isConnectedToPowerSource: true
120+
lastDefrostDateTime: '2023-10-23T15:40:28Z'
121+
measurements:
122+
ambientTemperature: 12
123+
temperature: 5
124+
temperatureUnit: CEL
125+
o2: 20
126+
co2: 25
127+
relativeHumidity: 98
128+
airExchange: 0
129+
airExchangeUnit: MQH
130+
cargoProbe1Temperature: 6
131+
cargoProbe2Temperature: 6
132+
cargoProbe3Temperature: 6
133+
currentPhaseA: 15
134+
currentPhaseB: 15
135+
currentPhaseC: 15
136+
dischargePressure: 21
137+
dischargeTemperature: 10
138+
evaporatorTemperature: 10
139+
lineFrequency: 60
140+
lineVoltage: 400
141+
returnProbe1Temperature: 10
142+
returnProbe2Temperature: 10
143+
returnTemperature: 10
144+
suctionPressure: 60
145+
suctionTemperature: 10
146+
supplySensor1Temperature: 10
147+
supplySensor2Temperature: 10
148+
supplyTemperature: 10
149+
setpoints:
150+
temperature: -15
151+
temperatureUnit: CEL
152+
o2: 20
153+
co2: 25
154+
humidity: 96
155+
reeferSettings:
156+
controlledAtmosphereMode: 'ON'
157+
isDefrosting: false
158+
efficiencySetting: 2
159+
unitModel: N00
160+
device:
161+
deviceDateTime: '2023-12-10T10:34:12Z'
162+
model: '100'
163+
receivedDateTime: '2023-12-10T10:34:12Z'
164+
isDeviceConnectedToPower: true
165+
brand: '2'
166+
inspection:
167+
- inspectionType: REMOTE
168+
inspectionDate: '2023-12-10T10:34:12Z'
169+
expiryDate: '2023-12-10T10:34:12Z'
170+
inspectionResult: PASSED
171+
heartbeatExampleWithAlarm:
172+
summary: "A 'full' notification of the reefer measurements at a point in time with activated alarm"
173+
description: Used to push the full payload to a subscriber for the Reefer Monitoring Operational (RMO) detailing the measurements and settings at point in time.
174+
value:
175+
alarms:
176+
activeAlarmCount: 0
177+
activeAlarms:
178+
- alarmDate: '2024-01-23T15:40:28Z'
179+
alarmNumber: N999
180+
alarmSeverity: ALARM
181+
controller:
182+
dateTime: '2023-10-23T15:40:28Z'
183+
hardwareVersion: 1.1.1
184+
maker: '900'
185+
model: N99
186+
operatingState: '1'
187+
serialNumber: '123456789'
188+
softwareVersion: 1.1.1
189+
equipmentReference: APZU4812090
190+
equipmentOptions:
191+
- N00
192+
- N05
193+
geoLocation:
194+
latitude: '48.858550'
195+
longitude: '2.294492'
196+
isConnectedToPowerSource: true
197+
lastDefrostDateTime: '2023-10-23T15:40:28Z'
198+
measurements:
199+
ambientTemperature: 12
200+
temperature: 5
201+
temperatureUnit: CEL
202+
o2: 20
203+
co2: 25
204+
relativeHumidity: 98
205+
airExchange: 0
206+
airExchangeUnit: MQH
207+
cargoProbe1Temperature: 6
208+
cargoProbe2Temperature: 6
209+
cargoProbe3Temperature: 6
210+
currentPhaseA: 15
211+
currentPhaseB: 15
212+
currentPhaseC: 15
213+
dischargePressure: 21
214+
dischargeTemperature: 10
215+
evaporatorTemperature: 10
216+
lineFrequency: 60
217+
lineVoltage: 400
218+
returnProbe1Temperature: 10
219+
returnProbe2Temperature: 10
220+
returnTemperature: 10
221+
suctionPressure: 60
222+
suctionTemperature: 10
223+
supplySensor1Temperature: 10
224+
supplySensor2Temperature: 10
225+
supplyTemperature: 10
226+
setpoints:
227+
temperature: -15
228+
temperatureUnit: CEL
229+
o2: 20
230+
co2: 25
231+
humidity: 96
232+
reeferSettings:
233+
controlledAtmosphereMode: 'ON'
234+
isDefrosting: false
235+
efficiencySetting: 2
236+
unitModel: N00
237+
device:
238+
deviceDateTime: '2023-12-10T10:34:12Z'
239+
model: '100'
240+
receivedDateTime: '2023-12-10T10:34:12Z'
241+
isDeviceConnectedToPower: true
242+
brand: '2'
243+
inspection:
244+
- inspectionType: REMOTE
245+
inspectionDate: '2023-12-10T10:34:12Z'
246+
expiryDate: '2023-12-10T10:34:12Z'
247+
inspectionResult: PASSED
98248
responses:
99249
'204':
100250
description: |
@@ -205,7 +355,7 @@ components:
205355
If a container does not comply with ISO 6346, it is suggested to follow [Recommendation #2: Containers with non-ISO identification](https://smdg.org/documents/smdg-recommendations) from SMDG.
206356
pattern: ^\S+(\s+\S+)*$
207357
maxLength: 11
208-
example: BICU4812097
358+
example: APZU4812090
209359
geoLocation:
210360
type: object
211361
properties:

0 commit comments

Comments
 (0)