diff --git a/Berth/schema.json b/Berth/schema.json index d34541f..a33360a 100644 --- a/Berth/schema.json +++ b/Berth/schema.json @@ -1,46 +1,74 @@ { - "$schema": "http://json-schema.org/schema#", - "$schemaVersion": "0.0.1", - "modelTags": "ESHUV", - "derivedFrom": "", - "license": "", - "$id": "https://raw.githubusercontent.com/smart-data-models/dataModel.MarineTransport/master/Berth/schema.json", - "title": "Smart Data models Berth schema", - "description": "This data model is intended to provide information about Berths. We define 'berth' to each stop of a ship during a PortCall, both for a port-facility (berth) and as an anchorage area. Each berth has a berthing time (estimated, planned, etc.), a lifecycle (estimated, requested, approved, etc.), an main activity during the stop (commercial operations, major repair, etc.) and a number of attributes described below. When commercial operations take place, an Operation entity will define the details of each commercial operation", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$schemaVersion": "0.3.4", + "modelTags": "IUDX", + "$id": "https://smart-data-models.github.io/dataModel.Weather/WeatherObserved/schema.json", + "title": "Weather Observed schema - Smart Data Models", + "description": "An observation of weather conditions at a certain place and time. This data model has been developed in cooperation with mobile operators and the GSMA.", "type": "object", "allOf": [ + { + "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons" + }, { "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons" }, { - "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons" + "$ref": "https://smart-data-models.github.io/dataModel.Weather/weather-schema.json#/definitions/Weather-Commons" }, { "properties": { "type": { "type": "string", - "description": "Property. NGSI Entity type. It has to be Berth", "enum": [ - "Berth" - ] + "WeatherObserved" + ], + "description": "Property. NGSI Entity type. It has to be WeatherObserved" }, - "mrn": { - "type": "string", - "description": "Property. MRN coded identifier. It has to be related to the entity in a way that is well-known by different organisms the meaning and the initiator of the entity, and all next parties will maintain on its original value. This identifier must be an UNIQUE identifier of the PortCall entity assigned by the system who created on first the entity. This URN should Conforms MRN & IETF specifically RFC 2141, RFC 5234, and RFC 8141. The proposed format is id::='urn:mrn:::portcalls:berth:id:[0-9]+' where OID:= Organisation UN/LOCODE, OONSS:=Organization Name of Service, 9999999 an increasing, unique identifier that the issuer of the Berth entity will identify on his systems (i.e. a SQL row-id), i.e. urn:mrn:eshuv:portcalls:berth:id:2024012. See [Unlocode](https://unece.org/trade/cefact/unlocode-code-list-country-and-territory). In international standards is also known as [Ship's Visit]" + "dateObserved": { + "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/dateObserved" }, - "portCode": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Code of the port of the call" + "precipitation": { + "type": "number", + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. Amount of water rain registered. Units:'Liters per square meter'. " }, - "year": { + "solarRadiation": { "type": "number", - "description": "Property. Model:'https://schema.org/Number'. Year of the init of the berthing" + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. The solar radiation observed measured in Watts per square. Units:'w/m2'" }, - "portCallNumber": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. PortCall identifier" + "directIrradiation": { + "type": "number", + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. Direct irradiance is the part of the solar irradiance that directly reaches a surface. Units:'w/m2'" + }, + "diffuseIrradiation": { + "type": "number", + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. Diffuse irradiance is the part of the solar irradiance that is scattered by the atmosphere. Units:'w/m2'" + }, + "pressureTendency": { + "oneOf": [ + { + "type": "string", + "enum": [ + "falling", + "raising", + "steady" + ] + }, + { + "type": "number" + } + ], + "description": "Property. Enum:'falling, raising, steady'. Is the pressure rising or falling? It can be expressed in quantitative terms or qualitative terms" + }, + "dewPoint": { + "type": "number", + "description": "Property. Model:'https://schema.org/Number'. Units:'Celsius degrees'. The dew point encoded as a number. Observed temperature to which air must be cooled to become saturated with water vapor" }, - "portCallRef": { + "refDevice": { "anyOf": [ { "type": "string", @@ -55,218 +83,55 @@ "description": "Property. Identifier format of any NGSI entity" } ], - "description": "Relationship.Reference to parent PortCall entity. " + "description": "Relationship. Model:'https://schema.org/URL'. A reference to the device(s) which captured this observation" }, - "stopRank": { + "streamGauge": { "type": "number", - "description": "Property. Model:'https://schema.org/Number'. Rank or Number of this stop in the PortCall activity ordered by arrival time in the sequence of stops (berthing/anchor area)" - }, - "terminal": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Common name of the Terminal" - }, - "berthCode": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Code identifying the port-facility for this stop of the vessel. Format: :berth:99999" - }, - "berthName": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Name of the port-facility for this stop of the vessel" + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. The water level surface elevation observed by Hydrometric measurement sensors, namely a [Stream Gauge](https://en.wikipedia.org/wiki/Stream_gauge) expressed in centimeters. Units:'centimeters'" }, - "gln": { + "snowHeight": { "type": "number", - "description": "Property. ISO/IEC 6523:'https://schema.org/Number'. Optional code of the location. The Global Location Number (GLN) is a 13 digits-unique number that is assigned to locations to enable them to be identified uniquely worldwide, allocated to any location in the supply chain. These GLNs can be used to identify any legal, physical and functional locations" - }, - "firstBollard": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. First bollard identifier in port facility" - }, - "lastBollard": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Last bollard identifier in port facility" - }, - "status": { - "type": "string", - "enum": [ - "ACCEPTED", - "AUTHORIZED", - "CANCELLED", - "COMPLETED", - "DENIED", - "INITIATED", - "REQUESTED", - "REJECTED", - "INVOICING", - "INVOICED" - ], - "description": "Property. Model:'https://schema.org/Text'. Current status of the Berthing in its lifetime, from request to authorization and completion. Enum:'ACCEPTED, AUTHORIZED, CANCELLED, COMPLETED, DENIED, INITIATED, REQUESTED, REJECTED, INVOICING, INVOICED'. [EMSWe: DE-019-07] [EDI: BGM-1225] [S211: serviceState: timeSequence:VESSEL] " - }, - "requestedAt": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of the berthing request by the ship agent. " - }, - "authorizedAt": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of authorization by port Authority and Maritime Authority. " - }, - "berthingTypeCode": { - "type": "string", - "enum": [ - "ABV", - "ABX", - "AB1", - "AB2", - "AEX", - "AX1", - "AEV", - "REM", - "REX", - "RE1", - "RE2", - "RPM", - "RPV", - "RPX", - "RXM", - "RXV", - "RXX", - "RX1", - "AE1", - "AE2", - "APM", - "APV", - "APX", - "AXM", - "AXV", - "AXX", - "AX2", - "FBM", - "FBV", - "FBX", - "FB1", - "FB2", - "FEM", - "FEV", - "FEX", - "FE1", - "FE2", - "FPM", - "FPV", - "FPX", - "FP1", - "FP2", - "FXM", - "FXV", - "FX1", - "FX2", - "RBM", - "RBX", - "RB1", - "RB2", - "RX2", - "YBM", - "YBV", - "YBX", - "YB1", - "YB2", - "YEM", - "YEV", - "YEX", - "YE1", - "YE2", - "YPM", - "YPV", - "YPX", - "YP1", - "YP2", - "YXM", - "YXV", - "YX1", - "YX2", - "ABM", - "AEM", - "FXX", - "YXX", - "AP1", - "AP2", - "RBV", - "REV" - ], - "description": "Property. Model:'https://schema.org/Text'. Codes for identifying the Type of berthing/mooring in the interface ship-port. Enum: ABV=Board port to ship; ABX=Port berthed; AB1=Bouched port by bow; AB2=Bouched port by stern; AEX=Starboard docked; AX1=Docked by bow; AEV=Board starboard to ship; REM=Boarded starboard at the pier; REX=Starboard bow; RE1=Starboard bow by bow; RE2=Cracked starboard by stern; RPM=Toe-to-spring twisting; RPV=Boarded from tip to ship; RPX=Ringed point; RXM=To moor alongside a dock; RXV=Moored to another vessel; RXX=Moored ; RX1=Tangled by bow; AE1=Bouched starboard by bow; AE2=Bouched starboard by stern; APM=Pocketed to the pier; APV=Pocket to ship; APX=Point docking; AXM=docked at the pier; AXV=Boarded to ship; AXX=docked; AX2=Docked by stern; FBM=Anchored port side at the pier; FBV=Anchored port side to ship; FBX=Port anchored; FB1=Anchored port by bow; FB2=Anchored port by stern; FEM=Anchored starboard to the pier; FEV=Anchored starboard to ship; FEX=Anchored starboard; FE1=Anchored starboard by bow; FE2=Anchored starboard by stern; FPM=Toe-to-pier mooring; FPV=Anchoring tip to ship; FPX=Point anchoring; FP1=Anchoring tip by bow; FP2=Anchoring tip by stern; FXM=Anchored at the pier; FXV=Anchored to ship; FX1=Anchored by bow; FX2=Anchored by stern; RBM=Moored portside to the dock; RBX=Battered port side; RB1=Bulked port by bow; RB2=Bulked on port side by stern; RX2=Tangled by stern; YBM=Tethered to the port buoy at the pier; YBV=Tethered to the buoy on the port side of the ship; YBX=Tethered to port buoy; YB1=Tied to port buoy by bow; YB2=Tied to port buoy by stern; YEM=Tethered to the starboard buoy at the pier; YEV=Tethered to the starboard buoy of the ship; YEX=Tethered to starboard buoy; YE1=Tied to starboard buoy by bow; YE2=Tied to starboard buoy by stern; YPM=Tethered to the end buoy at the pier; YPV=Tethered to the buoy end-to-ship; YPX=Tied to tip buoy; YP1=Tethered to tip buoy by bow; YP2=Tied to the tip buoy by stern; YXM=Tethered to the buoy at the pier; YXV=Tethered to the buoy to the ship; YX1=Tethered to buoy by bow; YX2=Tethered to buoy by stern; ABM=Port berthed to the pier; AEM=Moored starboard to dock; FXX=Anchoring; YXX=Tethered to buoy without further indication; AP1=Boarding tip by bow; AP2=Pocketed fore and aft; RBV=Bulked port to ship; REV=Wheeled starboard to ship;. " + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. The snow height observed by generic snow depth measurement sensors, expressed in centimeters. Units:'centimeters'" }, - "mooringLines": { + "uVIndexMax": { "type": "number", - "description": "Property. Model:'https://schema.org/Number'. Number of mooring lines. " - }, - "activityCode": { - "type": "string", - "enum": ["ZGR", "ZPV", "ZCA", "ZRA", "ZRF", "ZRT", "ZDA", "ZTA", "ZTF", "ZVO", "ZAF", "ZIN", "ZIP", "ZAR", "ZAO", "ZAB", "ZOP", "ZCT", "ZTI", "ZBO", "ZCO", "ZRE", "ZDE", "ZAP", "ZDR", "ZPB", "ZCL", "ZDJ", "ZMR", "ZPR", "ZRM", "ZVA", "ZDS", "ZOT", "EST", "ZSA", "ZSH", "ZSE", "ZSC", "ZSV"], - "description": "Property. Model:'https://schema.org/Text'. Activity during the stop in berth. It can be cargo operations or a number of activities related to the ship-port activities. Enum: ZGR=Major repair; ZPV=Provisioning; ZCA=Shipyard Construction; ZRA=Major shipyard repair; ZRF=Repair afloat with crew personnel; ZRT=Repair at anchor with personnel other than the crew; ZDA=Shipyard scrapping; ZTA=Shipyard Transformation; ZTF=Transformation; ZVO=Official visit; ZAF=Forced arrival; ZIN=Inactive; ZIP=Fishing inactivity; ZAR=Provisioning at docking; ZAO=Provisioning at anchor; ZAB=Provisioning at docking by barge; ZOP=Port operations of commercial traffic; ZCT=Sightseeing cruises; ZTI=Internal traffic; ZBO=Launching; ZCO=Construction; ZRE=Vessel intended for towing service; ZDE=Scrapyard; ZAP=Fishing and artisanal vessels in loading and unloading operations of fresh fish; ZDR=Vessel intended for dredging; ZPB=Biological stoppage; ZCL=No license; ZDJ=Judicial deposit; ZMR=Vessel intended for mooring service; ZPR=Vessel intended for pilotage service; ZRM=Trailer; ZVA=Access to slipway; ZDS=Vessel in dry dock; ZOT=Other; EST=Stay; ZSA=Water Supply; ZSH=Ice Supply; ZSE=Electrical Energy Supply; ZSC=Fuel Supply; ZSV=Victualling;" - }, - "etaBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of Estimated Time of Arrival to Berth expected by Port Authority (ISO 8601 UTC format). [EMSWe: DE-005-09] [EDI: DTM-2005-132] [S211: locationState.timeType.ESTIMATED] [IMO: IMO0064]" - }, - "rtaBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of Requested Time of Arrival by ship-agent (ISO 8601 UTC format).. [EMSWe: DE-005-09] [EDI: DTM-2005-132] [S211: locationState.timeType.ESTIMATED] [IMO: IMO0064]" - }, - "ptaBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Planned time of arrival to Berth" - }, - "ataBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Actual time of arrival to Berth" - }, - "etdBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of Estimated Time of Departure from Berth, expected by Port Authority. [EMSWe: DE-005-04] [EDI: DTM-2005-133] [S211: locationState.timeType.ESTIMATED] [IMO: IMO0066]" - }, - "rtdBerth": { - "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format, Date and time of Requested Time of Departure by ship-agent (ISO 8601 UTC format). [EMSWe: DE-005-09] [EDI: DTM-2005-132] [S211: locationState.timeType.ESTIMATED] [IMO: IMO0064]" + "minimum": 0, + "description": "Property. Model:'https://schema.org/Number'. The maximum UV index for the period, based on the World Health Organization's UV Index measure. [http://www.who.int/uv/intersunprogramme/activities/uv_index/en/](http://www.who.int/uv/intersunprogramme/activities/uv_index/en/) the values between 1 and 11 are the valid range for the index. The value 0 is for describing that no signal is detected so no value is stored" }, - "ptdBerth": { + "aqiMajorPollutant": { "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format. Planned time of departure from Berth" + "description": "Property. Model:'https://schema.org/Text'. Major pollutant in the Air Quality Index (AQI)" }, - "atdBerth": { + "aqiMajorPollutantForecast": { "type": "string", - "format": "date-time", - "description": "Property. Represented by an ISO 8601 UTC format. Actual time of departure from Berth" + "description": "Property. Model:'https://schema.org/Text'. Forecasted major air pollutant in the Air Quality Index (AQI) over a certain duration in future" }, - "arrivalDraught": { + "airTemperatureForecast": { "type": "number", - "description": "Property. Model:'https://schema.org/Number'. Draught at first-line secured for arriving navigation" + "description": "Property. Model:'https://schema.org/Number'. Forecasted value of air temperature over a certain duration in future" }, - "departureDraught": { + "precipitationForecast": { "type": "number", - "description": "Property. Model:'https://schema.org/Number'. Draught at last-line released for departure navigation" + "description": "Property. Model:'https://schema.org/Number'. Forecasted rainfall over a certain duration in future" }, - "remarks": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Remarks of the berthing, by Agent at Port or others" + "airQualityIndex": { + "type": "number", + "description": "Property. Model:'https://schema.org/Number'. Air quality index is a number used to report the quality of the air on any given day" }, - "authorizationRemarks": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Conditions to the berthing written by Port Authority" + "relativeHumidityForecast": { + "type": "number", + "description": "Property. Model:'https://schema.org/Number'. Forecasted relative humidity (water vapour in air) over a certain duration in future" }, - "agentName": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Name of PortCall's ship Agent" + "airQualityIndexForecast": { + "type": "number", + "description": "Property. Model:'https://schema.org/Number'. Forecasted overall Air Quality Index (AQI) over a certain duration in future" }, - "agentLegalCode": { - "type": "string", - "description": "Property. Model:'https://schema.org/Text'. Legal identifier code of the PortCall's ship Agent" + "airTemperatureTSA": { + "type": "object", + "description": "Property. Air temperature time series aggregation", + "$ref": "https://smart-data-models.github.io/dataModel.Environment/Environment-schema.json#/definitions/TimeSeriesAggregation" } } } @@ -274,7 +139,7 @@ "required": [ "id", "type", - "portCallRef", - "stopRank" + "dateObserved", + "location" ] } \ No newline at end of file