PSIXData


Click here for a complete list of operations.

getVesselSummaryXMLString

Returns XML String:



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.)

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /XML/PSIXData.asmx HTTP/1.1
Host: cgmix.uscg.mil
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://cgmix.uscg.mil/getVesselSummaryXMLString"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getVesselSummaryXMLString xmlns="https://cgmix.uscg.mil">
      <VesselID>string</VesselID>
      <VesselName>string</VesselName>
      <CallSign>string</CallSign>
      <VIN>string</VIN>
      <HIN>string</HIN>
      <Flag>string</Flag>
      <Service>string</Service>
      <BuildYear>string</BuildYear>
    </getVesselSummaryXMLString>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getVesselSummaryXMLStringResponse xmlns="https://cgmix.uscg.mil">
      <getVesselSummaryXMLStringResult>string</getVesselSummaryXMLStringResult>
    </getVesselSummaryXMLStringResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /XML/PSIXData.asmx HTTP/1.1
Host: cgmix.uscg.mil
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getVesselSummaryXMLString xmlns="https://cgmix.uscg.mil">
      <VesselID>string</VesselID>
      <VesselName>string</VesselName>
      <CallSign>string</CallSign>
      <VIN>string</VIN>
      <HIN>string</HIN>
      <Flag>string</Flag>
      <Service>string</Service>
      <BuildYear>string</BuildYear>
    </getVesselSummaryXMLString>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getVesselSummaryXMLStringResponse xmlns="https://cgmix.uscg.mil">
      <getVesselSummaryXMLStringResult>string</getVesselSummaryXMLStringResult>
    </getVesselSummaryXMLStringResponse>
  </soap12:Body>
</soap12:Envelope>