This XML Web Service exposes data concerning US Coast Guard Port State Information. The same data is available at http://cgmix.uscg.mil/psix (through an ASP.NET Interface).

The following operations are supported. For a formal definition, please review the Service Description.

• getOperationControls
  Returns:
  • 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
• getOperationControlsXMLString
  Returns:
  • 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
• getVesselCases
  Returns:
  • 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:
  • 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:
  • 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
• getVesselDeficienciesXMLString
  Returns:
  • 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
• getVesselDimensions
  Returns:
  • 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:
  • 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:
  • VesselID(Integer): Vessel Identification Number
  • TypeLookupName(String): Document Type
  • IssueDtTm(String): Issued Date
  • ExpiredDtTm(String): Expiration Date
  • OrganizationAbbr(String): Issuing Agency
• getVesselDocumentsXMLString
  Returns:
  • VesselID(Integer): Vessel Identification Number
  • TypeLookupName(String): Document Type
  • IssueDtTm(String): Issued Date
  • ExpiredDtTm(String): Expiration Date
  • OrganizationAbbr(String): Issuing Agency
• getVesselParticulars
  Returns:
  • VesselName(String): Vessel Name
  • VesselCallSign(String): Vessel Call Sign
  • CountryLookupName(String): Vessel Flag
  • ServiceType(String): Vessel Service 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:
  • VesselName(String): Vessel Name
  • VesselCallSign(String): Vessel Call Sign
  • CountryLookupName(String): Vessel Flag
  • ServiceType(String): Vessel Service 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:
  • 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:
  • 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:
  • VesselID(Integer): Vessel Identification Number
  • MeasureOfWeight(Integer): Weight
  • UnitOfMeasureLookupName(String): Weight Type
  • TonnageTypeLookupName(String): Tonnage Type
• getVesselTonnageXMLString
  Returns:
  • VesselID(Integer): Vessel Identification Number
  • MeasureOfWeight(Integer): Weight
  • UnitOfMeasureLookupName(String): Weight Type
  • TonnageTypeLookupName(String): Tonnage Type