LookUp Web Service

LookUp

Click here for a complete list of operations.

GetVesselsList

GetVesselsList(FieldName As String, FieldValue As String) As Vessels.
Searches the Vessel Files registered by the Port Authority.

Parameters:
-FieldName: Name of the field to search. Available FieldNames are: IMO, VesselName, CallSign, Flag, CallSign, VesselType, PortOfRegistry and ShipOwner.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
Returned values:
-Vessels: List of Vessel Files that meet the specified search criteria. The list of Vessel Files complies with the Vessels schema
-SOAP exception: Some kind of problem has occurred during the execution of the action. The SOAP exception will contain a complete description of the problem.

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 /services/lookup.asmx HTTP/1.1
Host: www.valenciaportpcs.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/Services/LookUp/GetVesselsList"

<?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>
    <GetVesselsList xmlns="http://tempuri.org/Services/LookUp">
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </GetVesselsList>
  </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>
    <GetVesselsListResponse xmlns="http://tempuri.org/Services/LookUp">
      <GetVesselsListResult>dataset</GetVesselsListResult>
    </GetVesselsListResponse>
  </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 /services/lookup.asmx HTTP/1.1
Host: www.valenciaportpcs.net
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>
    <GetVesselsList xmlns="http://tempuri.org/Services/LookUp">
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </GetVesselsList>
  </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>
    <GetVesselsListResponse xmlns="http://tempuri.org/Services/LookUp">
      <GetVesselsListResult>dataset</GetVesselsListResult>
    </GetVesselsListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /services/lookup.asmx/GetVesselsList?FieldName=string&FieldValue=string HTTP/1.1
Host: www.valenciaportpcs.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Vessels xmlns="http://tempuri.org/Services/LookUp">dataset</Vessels>