PSIXData
This XML Web Service exposes data concerning US Coast Guard Port State Information. The same data is available at https://cgmix.uscg.mil/psix (through an ASP.NET Interface).LOGICAL ORDER: Run the Vessel Summary service to retrieve the Vessel Id for the following services:Vessel ParticularsVessel DocumentsVessel DimensionsVessel TonnageVessel Cases. Run the Vessel Cases service to retrieve the Activity Id to run the Operation Controls service and Vessel Deficiencies service.
The following operations are supported. For a formal definition, please review the Service Description.
-
getOperationControls
Returns .NET Dataset:- ActivityID(Integer): Activity Identification Number
- ImposedDtTm(DateTime): Date Operational Control was Imposed
- RemovedDtTm(DateTime): Date Operational Control was Removed
- CategoryLookupName(String): Operational Control Category
- ReasonLookupName(String): Reason for Imposing Operational Control
- UnitName(String): Imposing CG Unit
- TypeLookupName(String): Type of Operation Control Imposed
- ImposedByActivityId(Integer): The activity Id for which the Operational Control was Imposed
- IsReviewedByHeadquarters(Bit): Reviewed by Headquarters Indicator
- IsInternationalMaritimeOrganizationReportable(Bit): Reportable to IMO Indicator
-
getOperationControlsXMLString
Returns XML String:- ActivityID(Integer): Activity Identification Number
- ImposedDtTm(DateTime): Date Operational Control was Imposed
- RemovedDtTm(DateTime): Date Operational Control was Removed
- CategoryLookupName(String): Operational Control Category
- ReasonLookupName(String): Reason for Imposing Operational Control
- UnitName(String): Imposing CG Unit
- TypeLookupName(String): Type of Operation Control Imposed
- ImposedByActivityId(Integer): The activity Id for which the Operational Control was Imposed
- IsReviewedByHeadquarters(Bit): Reviewed by Headquarters Indicator
- IsInternationalMaritimeOrganizationReportable(Bit): Reportable to IMO Indicator
-
getVesselCases
Returns .NET Dataset:- ActivityID(Integer): Activity Identification Number
- VesselId(Integer): Vessel Identification Number
- USCGZonePort(String): Port
- StartDtTm(String): Incident Start Date
- TypeLookupName(String): Activity Type Description
- ProcessStatusTypeLookupName(String): Case Status
- ProcessStatusSubTypeLookupName(String): Case Sub-Status
-
getVesselCasesXMLString
Returns XML String:- ActivityID(Integer): Activity Identification Number
- VesselId(Integer): Vessel Identification Number
- USCGZonePort(String): Port
- StartDtTm(String): Incident Start Date
- TypeLookupName(String): Activity Type Description
- ProcessStatusTypeLookupName(String): Case Status
- ProcessStatusSubTypeLookupName(String): Case Sub-Status
-
getVesselDeficiencies
Returns .NET Dataset:- VesselID(Integer): Vessel Identification Number
- ActivityNumber(Integer): Activity Identification Number
- System(String): System
- Description(String): Deficiency Description
- FailureCauseLookupName(String): Cause of the Deficiency
- IsResolved(Boolean): Resolved Indicator
- ResolutionDtTm(DateTime): Date the Deficiency Was Resolved
- ResolutionDueDtTm(String): Date To Be Resolved By
- ResolutionDescription(String): Description of the resolution
- SystemLookupName(String): System Involved
- SubSystemLookupName(String): Sub-System Involved
- ActionLookupName(String): Action Involved
- SystemComponentLookupName(String): Component Involved
- ActionCodeLookupName(String): Action Code Involved
-
getVesselDeficienciesXMLString
Returns XML String:- VesselID(Integer): Vessel Identification Number
- ActivityNumber(Integer): Activity Identification Number
- System(String): System
- Description(String): Deficiency Description
- FailureCauseLookupName(String): Cause of the Deficiency
- IsResolved(Boolean): Resolved Indicator
- ResolutionDtTm(DateTime): Date the Deficiency Was Resolved
- ResolutionDueDtTm(String): Date To Be Resolved By
- ResolutionDescription(String): Description of the resolution
- SystemLookupName(String): System Involved
- SubSystemLookupName(String): Sub-System Involved
- ActionLookupName(String): Action Involved
- SystemComponentLookupName(String): Component Involved
- ActionCodeLookupName(String): Action Code Involved
-
getVesselDimensions
Returns .NET Dataset:- VesselID(Integer): Vessel Identification Number
- DimensionTypeLookupId(Integer): Dimension Type Id
- DimensionTypeLookupName(String): Dimension Type
- BreadthInFeet(Decimal): Breadth
- DepthInFeet(Decimal): Depth
- LengthInFeet(Decimal): Length
-
getVesselDimensionsXMLString
Returns XML String:- VesselID(Integer): Vessel Identification Number
- DimensionTypeLookupId(Integer): Dimension Type Id
- DimensionTypeLookupName(String): Dimension Type
- BreadthInFeet(Decimal): Breadth
- DepthInFeet(Decimal): Depth
- LengthInFeet(Decimal): Length
-
getVesselDocuments
Returns .NET Dataset:- VesselID(Integer): Vessel Identification Number
- TypeLookupName(String): Document Type
- IssueDtTm(String): Issued Date
- ExpiredDtTm(String): Expiration Date
- OrganizationAbbr(String): Issuing Agency
-
getVesselDocumentsXMLString
Returns XML String:- VesselID(Integer): Vessel Identification Number
- TypeLookupName(String): Document Type
- IssueDtTm(String): Issued Date
- ExpiredDtTm(String): Expiration Date
- OrganizationAbbr(String): Issuing Agency
-
getVesselParticulars
Returns .NET Dataset:- VesselName(String): Vessel Name
- VesselCallSign(String): Vessel Call Sign
- CountryLookupName(String): Vessel Flag
- ServiceType(String): Vessel Service Type
- ServiceSubType(String): Vessel Service Sub Type
- CargoAuthorizationDescription(String): Vessel Cargo Authority Description
- ConstructionCompletedYear(String): Vessel Build Year
- StatusLookupName(String): Vessel Service Status
- OutOfServiceDate(DateTime): Out of Service Date - If Applicable
- VIN(String): Vessel Identification Number
- IdentificationTypeLookupName(String): Identification Type
-
getVesselParticularsXMLString
Returns XML String:- VesselName(String): Vessel Name
- VesselCallSign(String): Vessel Call Sign
- CountryLookupName(String): Vessel Flag
- ServiceType(String): Vessel Service Type
- ServiceSubType(String): Vessel Service Sub Type
- CargoAuthorizationDescription(String): Vessel Cargo Authority Description
- ConstructionCompletedYear(String): Vessel Build Year
- StatusLookupName(String): Vessel Service Status
- OutOfServiceDate(DateTime): Out of Service Date - If Applicable
- VIN(String): Vessel Identification Number
- IdentificationTypeLookupName(String): Identification Type
-
getVesselSummary
Returns .NET Dataset:- VesselID(Integer): Vessel Identification Number
- VesselName(String): Vessel Name
- Identification(String): Primary Vessel Identification Number
- HIN(String): Hull Identification Number
- VesselCallSign(String): Vessel Call Sign
- StatusLookupName(String): Vessel Status
- OutOfServiceDate(DateTime): Out of Service Date - If Applicable
- ServiceType(String): Vessel Service
- CountryLookupName(String): Vessel Flag
- ConstructionCompletedYear(Integer): Year Vessel Was Built
The following strings may be used for Vessel Service type searches:
- Commercial Fishing Vessel
- Fish Processing Vessel
- Freight Barge
- Freight Ship
- Industrial Vessel
- Mobile Offshore Drilling Unit
- Offshore Supply Vessel
- Oil Recovery
- Passenger (Inspected)
- Passenger (Uninspected)
- Passenger Barge (Inspected)
- Passenger Barge (Uninspected)
- Public Freight
- Public Tankship/Barge
- Public Vessel, Unclassified
- Recreational
- Research Vessel
- School Ship
- Tank Barge
- Tank Ship
- Towing Vessel
- Unclassified
- Unknown
- ALL
This procedure also accepts wild cards for Vessel Service. A search for 'Barge' will return all barges (i.e. Passenger Barge, Tank Barge, Freight Barge, etc.) -
getVesselSummaryXMLString
Returns XML String:- VesselID(Integer): Vessel Identification Number
- VesselName(String): Vessel Name
- Identification(String): Primary Vessel Identification Number
- HIN(String): Hull Identification Number
- VesselCallSign(String): Vessel Call Sign
- StatusLookupName(String): Vessel Status
- OutOfServiceDate(DateTime): Out of Service Date - If Applicable
- ServiceType(String): Vessel Service
- CountryLookupName(String): Vessel Flag
- ConstructionCompletedYear(Integer): Year Vessel Was Built
The following strings may be used for Vessel Service type searches:
- Commercial Fishing Vessel
- Fish Processing Vessel
- Freight Barge
- Freight Ship
- Industrial Vessel
- Mobile Offshore Drilling Unit
- Offshore Supply Vessel
- Oil Recovery
- Passenger (Inspected)
- Passenger (Uninspected)
- Passenger Barge (Inspected)
- Passenger Barge (Uninspected)
- Public Freight
- Public Tankship/Barge
- Public Vessel, Unclassified
- Recreational
- Research Vessel
- School Ship
- Tank Barge
- Tank Ship
- Towing Vessel
- Unclassified
- Unknown
- ALL
This procedure also accepts wild cards for Vessel Service. A search for 'Barge' will return all barges (i.e. Passenger Barge, Tank Barge, Freight Barge, etc.) -
getVesselTonnage
Returns .NET Dataset:- VesselID(Integer): Vessel Identification Number
- MeasureOfWeight(Integer): Weight
- UnitOfMeasureLookupName(String): Weight Type
- TonnageTypeLookupName(String): Tonnage Type
-
getVesselTonnageXMLString
Returns XML String:- VesselID(Integer): Vessel Identification Number
- MeasureOfWeight(Integer): Weight
- UnitOfMeasureLookupName(String): Weight Type
- TonnageTypeLookupName(String): Tonnage Type