4.3.1.20. Vessel (FV)¶
Note
Vessel is identified as Fully Validated.
4.3.1.20.1. Example Vessel¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | {
"pdef_id": "a595920f-1646-40d6-8b8c-52dce05ca963",
"pdef_type": "vessel",
"meta_data": {},
"additional_data": {},
"IMO_number": 9215359,
"name": "DEEP BLUE",
"ship_type": "Pipe Layer",
"flag": "Bahamas",
"year_of_built": 2001,
"length_overall": {
"val": 207.0,
"unit": "m"
},
"beam": {
"val": 32.0,
"unit": "m"
},
"gross_tonnage": {
"val": 33822.0,
"unit": "t"
}
}
|
4.3.1.20.2. Schema Vessel¶
pdef.model.vessel.VesselBase PDEF Object defining a vessel.
Show JSON schema
{ "title": "Vessel", "description": ":ref:`Base PDEF Object` defining a vessel.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "vessel", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "IMO_number": { "title": "IMO Number", "description": "International Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies.", "example": 9215359, "type": "integer" }, "name": { "title": "Vessel Name", "description": "Vessel name.", "example": "DEEP BLUE", "type": "string" }, "ship_type": { "title": "Ship Type", "description": "Type of vessel.", "example": "Pipe Layer", "anyOf": [ { "type": "string" }, { "enum": [ "Pipe Layer" ], "type": "string" } ] }, "flag": { "title": "Flag", "description": "Vessel country flag.", "example": "Bahamas", "enum": [ "Afghanistan", "Aland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei Darussalam", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo, The Democratic Republic of the", "Cook Islands", "Costa Rica", "Cote D'Ivoire", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and Mcdonald Islands", "Holy See (Vatican City State)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran, Islamic Republic Of", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Democratic People's Republic of Korea", "Korea, Republic of", "Kosovo", "Kuwait", "Kyrgyzstan", "Lao People's Democratic Republic", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libyan Arab Jamahiriya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao", "Macedonia, The Former Yugoslav Republic of", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia, Federated States of", "Moldova, Republic of", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Territory, Occupied", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russian Federation", "Rwanda", "Saint Helena", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syrian Arab Republic", "Taiwan", "Tajikistan", "Tanzania, United Republic of", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Viet Nam", "Virgin Islands, British", "Virgin Islands, U.S.", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ], "type": "string" }, "year_of_built": { "title": "Year of built", "description": "Year of Built.", "example": 2001, "type": "integer" }, "length_overall": { "title": "Length Overall", "description": "Overall vessel :ref:`Length`.", "example": { "val": 207.0, "uom": "m" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "beam": { "title": "Beam Length", "description": "Overall vessel beam :ref:`Length`.", "example": { "val": 32.0, "uom": "m" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "gross_tonnage": { "title": "Gross Tonnage", "description": ":ref:`Mass` for ship gross tonnage.", "example": { "val": 33822.0, "uom": "t" }, "allOf": [ { "$ref": "#/definitions/Mass" } ] } }, "additionalProperties": false, "definitions": { "MetaData": { "title": "MetaData", "description": "Optional base JSON-fragment used to report meta data. User free structure.", "type": "object", "properties": {} }, "AdditionalData": { "title": "AdditionalData", "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.", "type": "object", "properties": {} }, "Length": { "title": "Length", "description": ":ref:`Measure` of a length, distance, thickness, diameter, etc", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }, "Mass": { "title": "Mass", "description": ":ref:`Measure` of mass", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "g", "kg", "lb", "lbs", "t" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false } } }
- Config
extra: str = forbid
IMO_number: Optional[int] = PydanticUndefinedInternational Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies.
- Constraints and examples:
example = 9215359
beam: Optional[pdef.model.measure.Length] = PydanticUndefinedOverall vessel beam Length.
- Constraints and examples:
example = {‘val’: 32.0, ‘uom’: ‘m’}
flag: Optional[Literal[Afghanistan, Aland Islands, Albania, Algeria, American Samoa, Andorra, Angola, Anguilla, Antarctica, Antigua and Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Bouvet Island, Brazil, British Indian Ocean Territory, Brunei Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Cayman Islands, Central African Republic, Chad, Chile, China, Christmas Island, Cocos (Keeling) Islands, Colombia, Comoros, Congo, Congo, The Democratic Republic of the, Cook Islands, Costa Rica, Cote D’Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands (Malvinas), Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and Mcdonald Islands, Holy See (Vatican City State), Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Islamic Republic Of, Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Democratic People’s Republic of Korea, Korea, Republic of, Kosovo, Kuwait, Kyrgyzstan, Lao People’s Democratic Republic, Latvia, Lebanon, Lesotho, Liberia, Libyan Arab Jamahiriya, Liechtenstein, Lithuania, Luxembourg, Macao, Macedonia, The Former Yugoslav Republic of, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Micronesia, Federated States of, Moldova, Republic of, Monaco, Mongolia, Montenegro, Montserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norfolk Island, Northern Mariana Islands, Norway, Oman, Pakistan, Palau, Palestinian Territory, Occupied, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Puerto Rico, Qatar, Reunion, Romania, Russian Federation, Rwanda, Saint Helena, Saint Kitts and Nevis, Saint Lucia, Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syrian Arab Republic, Taiwan, Tajikistan, Tanzania, United Republic of, Thailand, Timor-Leste, Togo, Tokelau, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Turks and Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, United States Minor Outlying Islands, Uruguay, Uzbekistan, Vanuatu, Venezuela, Viet Nam, Virgin Islands, British, Virgin Islands, U.S., Wallis and Futuna, Western Sahara, Yemen, Zambia, Zimbabwe]] = PydanticUndefinedVessel country flag.
- Constraints and examples:
example = Bahamas
gross_tonnage: Optional[pdef.model.measure.Mass] = PydanticUndefinedMass for ship gross tonnage.
- Constraints and examples:
example = {‘val’: 33822.0, ‘uom’: ‘t’}
length_overall: Optional[pdef.model.measure.Length] = PydanticUndefinedOverall vessel Length.
- Constraints and examples:
example = {‘val’: 207.0, ‘uom’: ‘m’}
name: Optional[str] = PydanticUndefinedVessel name.
- Constraints and examples:
example = DEEP BLUE
pdef_type: str = 'vessel'
- Constraints and examples:
const = vessel
ship_type: Optional[Union[str, Literal[Pipe Layer]]] = PydanticUndefinedType of vessel.
- Constraints and examples:
example = Pipe Layer
year_of_built: Optional[int] = PydanticUndefinedYear of Built.
- Constraints and examples:
example = 2001
4.3.1.20.3. List Vessel¶
Variable |
Type |
Description |
|---|---|---|
pdef_id |
<class ‘str’> |
pdef_id is the unique identifier for the object. |
pdef_type |
<class ‘str’> |
|
meta_data |
<class ‘pdef.model.metadata.MetaData’> |
Optional user free structured MetaData object. |
additional_data |
<class ‘pdef.model.additional_data.AdditionalData’> |
Optional user free structured Additional Data object. |
IMO_number |
<class ‘int’> |
International Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies. |
name |
<class ‘str’> |
Vessel name. |
ship_type |
typing.Union[str, typing.Literal[‘Pipe Layer’], NoneType] |
Type of vessel. |
flag |
typing.Literal[‘Afghanistan’, ‘Aland Islands’, ‘Albania’, ‘Algeria’, ‘American Samoa’, ‘Andorra’, ‘Angola’, ‘Anguilla’, ‘Antarctica’, ‘Antigua and Barbuda’, ‘Argentina’, ‘Armenia’, ‘Aruba’, ‘Australia’, ‘Austria’, ‘Azerbaijan’, ‘Bahamas’, ‘Bahrain’, ‘Bangladesh’, ‘Barbados’, ‘Belarus’, ‘Belgium’, ‘Belize’, ‘Benin’, ‘Bermuda’, ‘Bhutan’, ‘Bolivia’, ‘Bosnia and Herzegovina’, ‘Botswana’, ‘Bouvet Island’, ‘Brazil’, ‘British Indian Ocean Territory’, ‘Brunei Darussalam’, ‘Bulgaria’, ‘Burkina Faso’, ‘Burundi’, ‘Cambodia’, ‘Cameroon’, ‘Canada’, ‘Cape Verde’, ‘Cayman Islands’, ‘Central African Republic’, ‘Chad’, ‘Chile’, ‘China’, ‘Christmas Island’, ‘Cocos (Keeling) Islands’, ‘Colombia’, ‘Comoros’, ‘Congo’, ‘Congo, The Democratic Republic of the’, ‘Cook Islands’, ‘Costa Rica’, “Cote D’Ivoire”, ‘Croatia’, ‘Cuba’, ‘Cyprus’, ‘Czech Republic’, ‘Denmark’, ‘Djibouti’, ‘Dominica’, ‘Dominican Republic’, ‘Ecuador’, ‘Egypt’, ‘El Salvador’, ‘Equatorial Guinea’, ‘Eritrea’, ‘Estonia’, ‘Ethiopia’, ‘Falkland Islands (Malvinas)’, ‘Faroe Islands’, ‘Fiji’, ‘Finland’, ‘France’, ‘French Guiana’, ‘French Polynesia’, ‘French Southern Territories’, ‘Gabon’, ‘Gambia’, ‘Georgia’, ‘Germany’, ‘Ghana’, ‘Gibraltar’, ‘Greece’, ‘Greenland’, ‘Grenada’, ‘Guadeloupe’, ‘Guam’, ‘Guatemala’, ‘Guernsey’, ‘Guinea’, ‘Guinea-Bissau’, ‘Guyana’, ‘Haiti’, ‘Heard Island and Mcdonald Islands’, ‘Holy See (Vatican City State)’, ‘Honduras’, ‘Hong Kong’, ‘Hungary’, ‘Iceland’, ‘India’, ‘Indonesia’, ‘Iran, Islamic Republic Of’, ‘Iraq’, ‘Ireland’, ‘Isle of Man’, ‘Israel’, ‘Italy’, ‘Jamaica’, ‘Japan’, ‘Jersey’, ‘Jordan’, ‘Kazakhstan’, ‘Kenya’, ‘Kiribati’, “Democratic People’s Republic of Korea”, ‘Korea, Republic of’, ‘Kosovo’, ‘Kuwait’, ‘Kyrgyzstan’, “Lao People’s Democratic Republic”, ‘Latvia’, ‘Lebanon’, ‘Lesotho’, ‘Liberia’, ‘Libyan Arab Jamahiriya’, ‘Liechtenstein’, ‘Lithuania’, ‘Luxembourg’, ‘Macao’, ‘Macedonia, The Former Yugoslav Republic of’, ‘Madagascar’, ‘Malawi’, ‘Malaysia’, ‘Maldives’, ‘Mali’, ‘Malta’, ‘Marshall Islands’, ‘Martinique’, ‘Mauritania’, ‘Mauritius’, ‘Mayotte’, ‘Mexico’, ‘Micronesia, Federated States of’, ‘Moldova, Republic of’, ‘Monaco’, ‘Mongolia’, ‘Montenegro’, ‘Montserrat’, ‘Morocco’, ‘Mozambique’, ‘Myanmar’, ‘Namibia’, ‘Nauru’, ‘Nepal’, ‘Netherlands’, ‘Netherlands Antilles’, ‘New Caledonia’, ‘New Zealand’, ‘Nicaragua’, ‘Niger’, ‘Nigeria’, ‘Niue’, ‘Norfolk Island’, ‘Northern Mariana Islands’, ‘Norway’, ‘Oman’, ‘Pakistan’, ‘Palau’, ‘Palestinian Territory, Occupied’, ‘Panama’, ‘Papua New Guinea’, ‘Paraguay’, ‘Peru’, ‘Philippines’, ‘Pitcairn’, ‘Poland’, ‘Portugal’, ‘Puerto Rico’, ‘Qatar’, ‘Reunion’, ‘Romania’, ‘Russian Federation’, ‘Rwanda’, ‘Saint Helena’, ‘Saint Kitts and Nevis’, ‘Saint Lucia’, ‘Saint Pierre and Miquelon’, ‘Saint Vincent and the Grenadines’, ‘Samoa’, ‘San Marino’, ‘Sao Tome and Principe’, ‘Saudi Arabia’, ‘Senegal’, ‘Serbia’, ‘Seychelles’, ‘Sierra Leone’, ‘Singapore’, ‘Slovakia’, ‘Slovenia’, ‘Solomon Islands’, ‘Somalia’, ‘South Africa’, ‘South Georgia and the South Sandwich Islands’, ‘Spain’, ‘Sri Lanka’, ‘Sudan’, ‘Suriname’, ‘Svalbard and Jan Mayen’, ‘Swaziland’, ‘Sweden’, ‘Switzerland’, ‘Syrian Arab Republic’, ‘Taiwan’, ‘Tajikistan’, ‘Tanzania, United Republic of’, ‘Thailand’, ‘Timor-Leste’, ‘Togo’, ‘Tokelau’, ‘Tonga’, ‘Trinidad and Tobago’, ‘Tunisia’, ‘Turkey’, ‘Turkmenistan’, ‘Turks and Caicos Islands’, ‘Tuvalu’, ‘Uganda’, ‘Ukraine’, ‘United Arab Emirates’, ‘United Kingdom’, ‘United States’, ‘United States Minor Outlying Islands’, ‘Uruguay’, ‘Uzbekistan’, ‘Vanuatu’, ‘Venezuela’, ‘Viet Nam’, ‘Virgin Islands, British’, ‘Virgin Islands, U.S.’, ‘Wallis and Futuna’, ‘Western Sahara’, ‘Yemen’, ‘Zambia’, ‘Zimbabwe’] |
Vessel country flag. |
year_of_built |
<class ‘int’> |
Year of Built. |
length_overall |
<class ‘pdef.model.measure.Length’> |
Overall vessel Length. |
beam |
<class ‘pdef.model.measure.Length’> |
Overall vessel beam Length. |
gross_tonnage |
<class ‘pdef.model.measure.Mass’> |
Mass for ship gross tonnage. |