VesselPortCallService
The following operations are supported. For a formal definition, please review the Service Description.
-
GetAllPortCalls
GetAllPortCalls() As VesselPortCallsLookup.
Returns the Valencia Port Authority authorised and requested vessel port calls.
This Web Service is public and it does not require any previous login to the system.
Parameters:
No parameters are required
Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
Remarks: VesselCallSign, IMONumber, VesselFlag and VesselFlagDescription will always return empty values. -
GetHistoricVesselPortCalls
GetHistoricVesselPortCalls(ByVal PortOfCall As String, ByVal VesselName As String, ByVal FromDate As String, ByVal Todate As String) As APVVesselPortCalls.
Returns the historic vessel port calls for the port code, vessel name and date period indicated as parameters.
Parameters:
PortOfCall: UN/LOCODE of the port where the port calls are to be retrieved. VesselName: Search by vessel name .
FromDate: Estimated date of arrival (ETA) from which port calls will be retrieved.
ToDate: Estimated date of arrival (ETA) until which port calls will be retrieved.
Returned values:
-APVVesselPortCalls: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
-
GetOperatingVessels
GetOperatingVessels() As VesselPortCallsLookup.
Returns the Valencia Port Authority vessel port calls of the vessels that are currently performing operations at the ports.
This Web Service is public and it does not require any previous login to the system.
Parameters:
No parameters are required
Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
Remarks: VesselCallSign, IMONumber, VesselFlag and VesselFlagDescription will always return empty values. -
GetOperationgVesselsMore
GetOperationgVesselsMore(ByVal PortOfCall As String) As APVVesselPortCalls.
Returns the operating vessel port calls for the port code.
Parameters:
PortOfCall: UN/LOCODE of the port where the port calls are to be retrieved. Returned values:
-APVVesselPortCalls: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
-
GetPortCallsByDate
GetPortCallsByDate(PortCode As String, Status as String, DateFrom as String, DateTo As String) As VesselPortCallsLookup.
Returns the Valencia Port Authority vessel port calls for the port code, status and date period indicated as parameters.
This Web Service is public and it does not require any previous login to the system.
Parameters:
PortCode: UN/LOCODE of the port where the port calls are to be retrieved. Allowed values are: ESVLC, ESGAN, ESSAG.
If PortCode is empty the search will consider all the Valenciaport ports.Status: Status of the port call. Allowed values are: AUT (authorised), SOL (requested).
If Status is empty the search will consider all the port call states.FromDate: Estimated date of arrival (ETA) from which port calls will be retrieved. Dates shall be in the format of YYYYMMDD.
If FromDate is empty the search will consider all the authorised and requested port calls not taking into account a start date.ToDate: Estimated date of arrival (ETA) until which port calls will be retrieved. Dates shall be in the format of YYYYMMDD.
If ToDate is empty the search will consider all the authorised and requested port calls not taking into account an end date.Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
Remarks: VesselCallSign, IMONumber, VesselFlag and VesselFlagDescription will always return empty values. -
GetPortCallsByPort
GetPortCallsByPort(PortCode As String) As VesselPortCallsLookup.
Returns the Valencia Port Authority authorised and requested vessel port calls for the port code indicated as parameter.
This Web Service is public and it does not require any previous login to the system.
Parameters:
PortCode: UN/LOCODE of the port where the port calls are to be retrieved. Allowed values are: ESVLC, ESGAN, ESSAG.
If PortCode is empty the search will be for all of the Valenciaport ports.Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
Remarks: VesselCallSign, IMONumber, VesselFlag and VesselFlagDescription will always return empty values. -
GetPortCallsByStatus
GetPortCallsByStatus(PortCode As String, Status as String) As VesselPortCallsLookup.
Returns the Valencia Port Authority vessel port calls for the port code and the status indicated as parameters.
This Web Service is public and it does not require any previous login to the system.
Parameters:
PortCode: UN/LOCODE of the port where the port calls are to be retrieved. Allowed values are: ESVLC, ESGAN, ESSAG.
If PortCode is empty the search will consider all the Valenciaport ports.Status: Status of the port call. Allowed values are: AUT (authorised), SOL (requested).
If Status is empty the search will consider all the port call states.Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
Remarks: VesselCallSign, IMONumber, VesselFlag and VesselFlagDescription will always return empty values. -
GetVesselPortCalls
GetVesselPortCalls(ByVal PortOfCall As String, ByVal Status As String, ByVal FromDate As String, ByVal Todate As String) As APVVesselPortCalls.
Returns the vessel port calls for the port code, status and date period indicated as parameters.
Parameters:
PortOfCall: UN/LOCODE of the port where the port calls are to be retrieved. Status: Status of the port call. Allowed values are: AUT (authorised), SOL (requested).
FromDate: Estimated date of arrival (ETA) from which port calls will be retrieved.
ToDate: Estimated date of arrival (ETA) until which port calls will be retrieved.
Returned values:
-APVVesselPortCalls: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.
-
SearchVesselPortCalls
SearchVesselPortCalls(ByVal FromDate As String, ByVal ToDate As String, ByVal VesselAgentName As String, ByVal GoodsOwnerName As String, ByVal VesselName As String, ByVal PortValencia As Boolean, ByVal PortGandia As Boolean, ByVal PortSagundo As Boolean, ByVal StatusSol As Boolean, ByVal StatusAut As Boolean, ByVal StatusHIS As Boolean, ByVal StatusOPER As Boolean) As APVVesselPortCalls.
Returns vessel port calls including the search parameters introduced
Parameters:
FromDate: Estimated date of arrival (ETA) from which port calls will be retrieved.
ToDate: Estimated date of arrival (ETA) until which port calls will be retrieved.
VesselAgentName: Search by name of agent .
GoodsOwnerName: Search by goods owner name.
VesselName: Search by vessel name .
PortValencia: Indicates whether to include vessel port calls of the port of Valencia.
PortGandia: Indicates whether to include vessel port calls of the port of Gandia.
PortSagundo: Indicates whether to include vessel port calls of the port of Sagundo.
StatusSol: Indicate whether they should include the scales with state Requested.
StatusAut: Indicate whether they should include the scales with state authorized.
StatusHIS: Indicate whether they should include the scales with state historical.
StatusOPER: Indicate whether they should include the scales with operating state.
Returned values:
-APVVesselPortCalls: List of Vessel Port Calls. The list of Vessel Port Calls complies with the Vessel Port Calls 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.