LookUp
The following operations are supported. For a formal definition, please review the Service Description.
-
BasicGroupContainerTypesForService
BasicGroupContainerTypesForService(Service As String) As GroupContainerTypes.
Returns Container Types according to ISO 6346 Grouped Container Types for a determinated service.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Service: Service code.
Returned values:
-GroupContainerTypes: List of Container Type Groups that meet the specified search criteria. The list of Container Type Groups complies with the Group Container Types 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.
-
BasicISOContainerTypesForService
BasicISOContainerTypesForService(Service as String ) As ISOContainerTypes.
Returns Basic Container Types according to ISO 6346 Container Types for a determinated service.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Service: Service code to search. Empty string to retrieve all entries.
Returned values:
-ISOContainerTypes: List of Container Types that meet the specified search criteria. The list of Container Types complies with the ISO Container Types 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.
-
CarriersGetListForOrgAndService
CarriersGetListForOrgAndService(SCAC As String, Name As String, OrganizationCode As String, ServiceCode As String) As Carriers.
Searches the Maritime Carrier companies configured for OrganizationCode and ServiceCode by the Valenciaport Portal.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-SCAC: Search criteria for the SCAC (Standard Alpha Code) code. Empty string to retrieve all maritime carriers.
-Name: Search criteria for the Maritime Carrier Name. Empty string to retrieve all maritime carriers.
-OrganizationCode: Search criteria for the OrganizationCode.
-ServiceCode: Search criteria for the Service Code.
Returned values:
-Carriers: List of maritime carrier companies. The list of Maritime Carrier companies complies with the Carriers 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.
-
CheckAPVCountries
CheckAPVCountries(Code As String) As String.
Checks an APV Country code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckAPVLocations
CheckAPVLocations(Code As String, IsPort As Integer) As String.
Checks a APV location/port code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-IsPort: Flag to limiting the search to ports. Available values: 0 (All locations), 1 (Ports).
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckAPVPackageTypes
CheckAPVPackageType(Code As String) As String.
Checks a Package Type Port Authority code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckAnnexMessageTypeIsValid
CheckAnnexMessageTypeIsValid(CallReference As String, MessageType As String, MessageNumber As String) As Boolean.
Check the message type to be unique for the given CallReference
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CallReference: Reference of vessel call.
-MessageType: Type of annex to check. Available MessageType are: WASDIS, PAXPASARR, PAXPASDEP, PAXCRWARR, PAXCRWDEP, DOCSCAN
-MessageNumber: Message identifier to check.
Returned values:
-True: Annex message type is unique.
-False: Annex message type already exists.
-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.
-
CheckAuthorizationInstructionsTypeDG
CheckAuthorizationInstructionsTypeDG(Origin As String, Code As String) As String.
Checks an AuthorizationInstructionsType.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Origin: Origin to check. Available values are: C (CapitanÃa), P (Puerto)
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckAuthorizationInstructionsTypes
CheckAuthorizationInstructionsTypes(Code As String) As String.
Checks an AuthorizationInstructionsType.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckCallAgreements
CheckCallAgreements(ByVal Code As String, ByVal OrganizationCode As String) As String.
Checks a registered Port Call Agreement for Vessel Calls.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-OrganizationCode: Search criteria for the OrganizationCode.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckCargoTypes
CheckCargoTypes(Code As String) As String.
Checks a Cargo Type Code as defined by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckClubPO
CheckClubPO(Code As String) As String.
Checks a Club P&O insurance company as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckCurrency
CheckCurrency(Code As String) As String.
Checks an ISO Currency code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckCustomsLocations
CheckCustomsLocations(Code As String) As String.
Checks a registered Custom Location Type.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckCustomsLocationsForDate
CheckCustomsLocations(Code As String, ValidityDate As Date) As String.
Checks a registered Custom Location Type valid on a specific date.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-ValidityDate: Date to check if the location is valid.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckEquipmentTypes
CheckEquipmentTypes(VPCode As String) As String.
Checks a registered Equipment Type.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-VPCode: VPCode to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckGroupContainerTypes
CheckGroupContainerTypes(GroupType As String) As String.
Checks an ISO 6346 Container Type Group code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-GroupType: Group type to check.
Returned values:
-Description:Description of the group type or empty string if the code does not exist.
-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.
-
CheckHullInsurance
CheckHullInsurance(Code As String) As String.
Checks a Hull Insurance Company code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckImdg
CheckImdg(ONUNumber As String, Variant As String, Culture As String) As String.
Checks a imdg code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-ONUNumber: Number assigned by United Nations for the hazardous substance.
-Variation: The variation specified in the IMDG Code.
-Culture: The language of the returned data. It could be ES for Spanish or EN for English.
Returned values:
-Description:Returns the proper name and variation in the requested language.
-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.
-
CheckImdgESOnlyNumber
CheckImdgESOnlyNumber(ONUNumber As String) As String.
Checks a imdg code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-ONUNumber: Number assigned by United Nations for the hazardous substance.
Returned values:
-Description:Returns the proper spanish name.
-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.
-
CheckIsoContainerTypes
CheckIsoContainerTypes(ISOType As String) As String.
Checks an ISO 6346 Container Type code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-ISOType: ISO type to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckIsoCountries
CheckIsoCountries(Code As String) As String.
Checks an ISO Country code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckLeasingAgents
CheckLeasingAgents(LeasingAgentCode As String) As String.
Checks a registered leasing agent code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-LeasingAgentCode: Code to check.
Returned values:
-LeasingAgentName:Name of the leasing agent or empty string if the code does not exist.
-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.
-
CheckLocationInSchengenArea
CheckLocationInSchengenArea(Code As String, ETADate as Date) As Boolean.
Check if a UN/LOCODE location/port code is in Schengen Area.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-ETADate: Date to check if the Schengen Area is effective.
Returned values:
-True: Location is in Schengen Area.
-False: Location is not in Schengen Area.
-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.
-
CheckLocationInSchengenAreaPaxlst
CheckLocationInSchengenAreaPaxlst(Code As String, ETADate as Date) As Boolean.
Check if a UN/LOCODE location/port code is in Schengen Area for Paxlst.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-ETADate: Date to check if the Schengen Area is effective for Paxlst.
Returned values:
-True: Location is in Schengen Area for Paxlst.
-False: Location is not in Schengen Area for Paxlst.
-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.
-
CheckLocations
CheckLocations(Code As String, IsPort As Integer) As String.
Checks a UN/LOCODE location/port code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
-IsPort: Flag to limiting the search to ports. Available values: 0 (All locations), 1 (Ports).
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckMaritimeCarriers
CheckMaritimeCarriers(SCAC As String) As String.
Checks a Maritime Carrier code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-SCAC: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckOrganizationExist
CheckOrganizationExist(OrgCode As String) As String.
Returns TRUE if the organization exists.
Parameters:
-OrgCode: Organization Code.
Returned values:
-True: Organization exists.
-False: Organization not exists.
-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.
-
CheckPackageTypes
CheckPackageTypes(Code As String) As String.
Checks a Package Type Valenciaport code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckPortAuthorityAddressBookContact
CheckPortAuthorityAddressBookContact(CIF As String, PartyType As String, ContactType As String, ContactField As String, ContactValue As String) As String.
Checks if the data supplied for a contact is registered in the Port Authority Address Book.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CIF: The company fiscal number assigned for taxes.
-PartyType: The type of company. Available companies registered by the Port Authority are: Vessel agents (CV), Cargo Agents (CN) and Terminals (TR).
-ContactType: The type of contact to search. Available contact types registered by the Port Authority are: Information Contact (IC) and Terminal Operator (TR).
-ContactField: The field of the contact to check. Available contact fields available to search are: Fiscal code assigned to the contact for taxes (NIF), Phone (PH), Fax (FX), Email (EM), EDI number (EI) and Radio Frequency Dial (VHF).
-ContactValue: The value of the contact to check.
Returned values:
-Description:Name of the contact or empty string if the contact does not exist.
-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.
-
CheckPortAuthorityAddressBookPartyCIF
CheckPortAuthorityAddressBookPartyCIF(CIF As String, PartyType As String) As String.
Checks if the Organization CIF is registered in the Port Authority Address Book.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CIF: The company fiscal number assigned for taxes.
-PartyType: The type of company. Available companies registered by the Port Authority are: Vessel agents (CV), Cargo Agents (CN) and Terminals (TR).
Returned values:
-Description:Name of the company or empty string if the code does not exist.
-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.
-
CheckQuay
CheckQuay(Port As String, Code As String) As String.
Checks a Port Quay code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Port: The UN/LOCODE code for the Port managed by the Port Authority. Empty string to retrieve all quays.
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckRegularService
CheckRegularService(Code As String) As String.
Checks a Regular Service code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckShipOwner
CheckShipOwner(Code As String) As String.
Checks a Shipowner code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckTARICGoodsCodes
CheckTARICGoodsCodes(CompletedCode As String) As String.
Checks a registered TARIC goods code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CompletedCode: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckVessel
CheckVessel(IMO As String) As String.
Checks a Vessel IMO code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-IMO: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckVesselClassificationSocieties
CheckVesselClassificationSocieties(Code As String) As String.
Checks a Vessel Classification Society code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckVesselPortCalls
CheckVesselPortCalls(CallReference As String, VesselAgentCIF As String, CargoAgentCIF As String, Departure As Boolean) As String.
Checks a registered Vessel Port Call.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CallReference: CallReference to check.
-VesselAgentCIF: Fiscal code of the Vessel Agent that presented the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-CargoAgentCIF: Fiscal code of the Cargo Agent that it is included in the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-Departure: Indicates if Cargo Agent is to the arrival or departure in the Call Request.
Returned values:
-PortOfCall:Port of Call or empty string if the CallReference does not exist.
-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.
-
CheckVesselPortCallsFTB
CheckVesselPortCallsFTB(OrganizationCode As String, MessageFunction As String, IMO As String) As String.
Checks a registered Vessel Port Call FTB.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-OrganizationCode: Vessel Port Call FTB owner.
-MessageFunction: Vessel Port Call FTB Message Function.
-IMO: Vessel IMO Number.
Returned values:
-VesselName:Vessel Name or empty string if the Vessel Port Call FTB does not exist.
-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.
-
CheckVesselType
CheckVesselType(Code As String) As String.
Checks a Vessel Type code as registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
CheckWarehouse
CheckWarehouse(Port As String, Code As String) As String.
Checks a Warehouse code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Port: The UN/LOCODE code for the Port managed by the Port Authority. Empty string to retrieve all warehouse.
-Code: Code to check.
Returned values:
-Description:Description of the code or empty string if the code does not exist.
-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.
-
GetCarriersForVgm
GetCarriersForVgm() As String.
Returns a string with a list of carriers which can be used in Vgm messages.
- GetDocumentDescriptions
- GetDocumentStatus
- GetHomePageServiceList
-
GetImdg
GetImdg(ONUNumber As String, Variant As String, Culture As String, SessionTicket As String) As ImdgCodes.
Returns the Imdg Data of a hazardous substance according to its onu number and variation.
This Web Service is restricted to logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-ONUNumber: Number assigned by United Nations for the hazardous substance.
-Variation: The variation specified in the IMDG Code.
-Culture: The language of the returned data. It could be ES for Spanish or EN for English.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-ImdgCodes: Complete Imdg data of the hazardous substance. The list of Imdg codes complies with the Imdg Codes 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.
-
GetImdgByService
GetImdgByService(ONUNumber As String, Variant As String, Culture As String, SessionTicket As String, Service As String) As ImdgCodes.
Returns the Imdg Data of a hazardous substance according to its onu number and variation.
This Web Service is restricted to logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-ONUNumber: Number assigned by United Nations for the hazardous substance.
-Variation: The variation specified in the IMDG Code.
-Culture: The language of the returned data. It could be ES for Spanish or EN for English.
-SessionTicket: The Ticket returned by the Login Web Service
-Service: The service that requires the data.
Returned values:
-ImdgCodes: Complete Imdg data of the hazardous substance. The list of Imdg codes complies with the Imdg Codes 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.
-
GetML_MaritimeLines
GetML_MaritimeLines(lineCode As String, lineName, orgCode As String, cargoTerminalCode As String) As ML_MaritimeLines.
Searches the Maritime Lines codes and descriptions .
Parameters:
-lineCode: Not used. Preserved for backwards compatibility. Should be an empty string.
-lineName: Not used. Preserved for backwards compatibility. Should be an empty string.
-orgCode: Not used. Preserved for backwards compatibility. Should be an empty string.
-cargoTerminalCode: Not used. Preserved for backwards compatibility. Should be an empty string.
Returned values:
-ML_MaritimeLineCodes: List of maritime agent lines that meet the specified search criteria. The list of maritime agent lines complies with the ML_MaritimeLineCodes 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.
-
GetNewDocumentNumber
GetNewDocumentNumber(SessionTicket As String, documentType As String, serviceName As String) As String.
Returns a new document number for the if the organization exists.
Parameters:
-SessionTicket: session ticket.
-documentType: document type.
-serviceName: service name.
Returned values:
-Description:the document number assigned.
-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.
-
GetOrganizationCountryCodeByCIF
GetOrganizationCountryCodeByCIF(ByVal CIF As String, ByVal SessionTicket As String) As Parties.
Returns the Country Code of a Organization according to a given CIF.
This Web Service requires the use of the Ticket returned by the login service.
Parameters:
-CIF: Number assigned by United Nations for the hazardous substance.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-EORI Code: The Country Code wich is a concatenated string of the Country Code and the CIF
-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.
- GetOrganizationType
-
GetPCSCodeFromAPVCode
GetPCSCodeFromAPVCode(APVCode As String) As String.
Gets the Organization Code from the apvcode specified.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-APVCode:The APVCode assigned to the organization.
Returned values:
-PCSCode:The company PCS code.
-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.
-
GetPortAuthorityAddressBookContactCommValue
GetPortAuthorityAddressBookContactCommValue(CIF As String, PartyType As String, ContactType As String, ContactNif As String, ContactCommType As String) As String.
Gets the contact communication value in the Port Authority Address Book.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CIF: The company fiscal number assigned for taxes.
-PartyType: The type of company. Available companies registered by the Port Authority are: Vessel agents (CV), Cargo Agents (CN) and Terminals (TR).
-ContactType: The type of contact to search. Available contact types registered by the Port Authority are: Information Contact (IC) and Terminal Operator (TR).
-ContactNif: The nif of the contact to check.
-ContactCommType: The type of communication contact to search. Available contact fields available to search are: Phone (PH), Fax (FX), Email (EM), EDI number (EI) and Radio Frequency Dial (VHF).
Returned values:
-Description:Value of the communication contact type or empty string if the contact does not exist.
-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.
-
GetPortAuthorityAddressBookPartyCode
GetPortAuthorityAddressBookPartyCode(CIF As String, PartyType As String) As String.
Gets the Organization Code in the Port Authority Address Book.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CIF: The company fiscal number assigned for taxes.
-PartyType: The type of company. Available companies registered by the Port Authority are: Vessel agents (CV), Cargo Agents (CN) and Terminals (TR).
Returned values:
-Description:Name of the company or empty string if the code does not exist.
-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.
-
GetVesselPortCallData
GetVesselPortCallData(CallReference As String, VesselAgentCIF As String, CargoAgentCIF As String, SessionTicket As String) As VesselPortCallsLookup.
Returns the Vessel Port Call registered by the Port Authority.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
Parameters:
-CallReference: CallReference of the Vessel Port Call.
-VesselAgentCIF: Fiscal code of the Vessel Agent that presented the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-CargoAgentCIF: Fiscal code of the Cargo Agent that it is included in the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-VesselPortCallsLookup: Vessel Port Call File. The Vessel Port Call File complies with the VesselPortCallsLookup 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.
-
GetVesselTechnicalData
GetVesselTechnicalData(IMO As String, Ticket As String) As Vessels.
Returns the Vessel File registered by the Port Authority.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
Parameters:
-IMO: IMO Number of the Vessel.
-Ticket: The Ticket returned by the Login Web Service
Returned values:
-Vessels: Vessel File. The Vessel File 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.
-
GetVesselTechnicalDataByIdentifier
GetVesselTechnicalDataByIdentifier(IMO As String, CallSign As String, FlagCode As String, MMSINumber As String, Ticket As String) As Vessels.
Returns the Vessel File registered by the Port Authority.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
Parameters:
-IMO: IMO Number of the Vessel.
-CallSign: CallSign of the Vessel.
-FlagoCode: FlagoCode of the Vessel.
-MMSINumber: MMSINumber of the Vessel.
-Ticket: The Ticket returned by the Login Web Service
Returned values:
-Vessels: Vessel File. The Vessel File 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.
-
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.
-
GetsQuayCommissarQuaysField
GetsQuayCommissarQuaysField(Field As String, Code As String) As String.
Checks the Commissar Quay code of a Port Quay code.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-Field: Field to obtain.
-Code: Code of Port Quay.
Returned values:
-FieldValue:Field value of the commissar quay or empty string if the commissar quay of port quay does not exist.
-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.
-
NewSearchVesselPortCalls
NewSearchVesselPortCalls(ByVal FilterName As String, ByVal FilterValue As String, ByVal WithBerthInTerminals As Boolean, ByVal SessionTicket As String) As NewVesselPortCallsLookUp.
Returns vessel port calls including the search parameters introduced
Parameters:
-FilterName: Name of the field to search.
-FilterValue: Search criteria for the field name. Empty string to retrieve all entries.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-NewVesselPortCalls: 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.
-
NewSearchVesselPortCallsWithVoyageType
NewSearchVesselPortCallsWithVoyageType(ByVal FilterName As String, ByVal FilterValue As String, ByVal WithBerthInTerminals As Boolean, ByVal GetLoadingVoyage As Boolean, ByVal SessionTicket As String) As NewVesselPortCallsLookUp.
Returns vessel port calls including the search parameters introduced
Parameters:
-FilterName: Name of the field to search.
-FilterValue: Search criteria for the field name. Empty string to retrieve all entries.
-GetLoadingVoyage: If true, returned VoyageNumber column will contain loading voyage number. If false, the column will contain unloading voyage number.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-NewVesselPortCalls: 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.
-
SearchAPVCountries
SearchAPVCountries(Code As String, Name As String) As Countries.
Searches the Country codes and descriptions as defined by APV.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for country code. Empty string to retrieve all countries.
-Name: Search criteria for country name. Empty string to retrieve all countries.
Returned values:
-Contries: List of countries that meet the specified search criteria. The list of countries complies with the Countries 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.
-
SearchAPVCountriesCommunitary
SearchAPVCountriesCommunitary(Code As String, Name As String) As Countries.
Searches the Country codes and descriptions as defined by APV.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for country code. Empty string to retrieve all countries.
-Name: Search criteria for country name. Empty string to retrieve all countries.
-IsCommunitary: Flag to limiting the search to communitary countries. Available values: 0 (All locations), 1 (Communitary countries).
Returned values:
-Contries: List of countries that meet the specified search criteria. The list of countries complies with the Countries 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.
-
SearchAPVLocations
SearchAPVLocations(CityCode As String, CityName As String, StateCode As String, StateName As String, CountryCode As String, CountryName As String, IsPort As Integer) As Locations.
Searches APV ports and locations.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-CityCode: Search criteria for the city/port code (5 characters). Empty string to retrieve all codes.
-CityName: Search criteria for the name of the city/port. Empty string to retrieve all entries.
-StateCode: Search criteria for the State code. Empty string to retrieve all entries.
-StateName: Search criteria for the name of the State. Empty string to retrieve all entries.
-CountryCode: Search criteria for the Country code. Empty string to retrieve all entries.
-CountryName: Search criteria for the name of the Country. Empty string to retrieve all entries.
-IsPort: Flag to limiting the search to ports. Available values: 0 (All locations), 1 (Ports).
Returned values:
-Locations: List of Locations that meet the specified search criteria. The list of Locations complies with the Locations 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.
-
SearchAPVPackageTypes
SearchAPVPackageTypes(PackageCode As String, Description As String, Descripcion As String) As PackageTypes.
Searches the Package Types registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-PackageCode: Search criteria for the Valenciaport Package code (Valenciaport Package codes are UN Rec. 21 codes where available). Empty string to retrieve all codes.
-Description: Search criteria for the english description of package types. Empty string to retrieve all entries.
-Descripcion: Search criteria for the spanish description of package types. Empty string to retrieve all entries.
Returned values:
-PackageTypes: List of Package Types that meet the specified search criteria. The list of Package Types complies with the Package Types 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.
-
SearchCallAgreements
SearchCallAgreements(Code As String, Description As String, ByVal OrganizationCode As String) As PortCallAgreements.
Searches registered Port Call Agreements for Vessel Calls.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
-OrganizationCode: Search criteria for the OrganizationCode.
Returned values:
-PortCallAgreements: List of Port Call Agreements that meet the specified search criteria. The list of Port Call Agreements complies with the Port Call Agreements 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.
-
SearchCargoTypes
SearchCargoTypes(Code As String, Description As String) As CargoTypes.
Searches Cargo Types as are classified by the Port Authority in berth operations.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-CargoTypes: List of Cargo Types that meet the specified search criteria. The list of Cargo Types complies with the Cargo Types 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.
-
SearchCarriersWithTicketAndCif
SearchCarriersWithTicketAndCif(Code As String, Name As String, Cif as String, ServiceCode As String, Ticket As String) As Parties.
Searches registered Carriers in the Valenciaport Portal.
This Web Service requieres a previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the organization. Empty string to retrieve all entries.
-Name: Search criteria for the name of the organization. Empty string to retrieve all entries.
-Cif: Cif of the party. Empty string to retrieve all entries.
-ServiceCode: Service associated with the party.
-Ticket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Carriers that meet the specified search criteria. The list of Carriers complies with the Parties 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.
-
SearchClubPO
SearchClubPO(Code As String, Description As String) As ClubPO.
Searches Club P&O insurance companies registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-ClubPO: List of Club P&O insurance companies that meet the specified search criteria. The list of Club P&O companies complies with the Club P&O 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.
-
SearchCurrencies
SearchCurrencies(Code As String, Description As String) As Currencies.
Searches currency codes and description as defined by ISO.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-Currencies: List of Currency Types that meet the specified search criteria. The list of Currency Types complies with the Currencies 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.
-
SearchCustomsLocations
SearchCustomsLocations(Code As String, Description As String, Port As String) As CustomsLocations.
Searches Customs Locations.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
-Port: Search criteria for port. Empty string to retrieve all ports.
Returned values:
-CustomsLocations: List of Customs Locations that meet the specified search criteria. The list of Customs Locations complies with the Customs Locations 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.
-
SearchCustomsLocationsForDate
SearchCustomsLocations(Code As String, Description As String, Port As String, ValidityDate As Date) As CustomsLocations.
Searches Customs Locations valid on a specific date.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
-Port: Search criteria for port. Empty string to retrieve all ports.
-ValidityDate: Date to check if the location is valid.
Returned values:
-CustomsLocations: List of Customs Locations that meet the specified search criteria. The list of Customs Locations complies with the Customs Locations 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.
-
SearchDangerousGoodsNotifications
SearchDangerousGoodsNotifications(CallReference As String, Input As Boolean, SessionTicket As String) As DangerousGoodsNotifications.
Searches Vessel Port Calls.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-CallReference: Reference of vessel call request.
-Input: Search criteria for Input/Output Call Reference.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-DangerousGoodsNotifications: List of Dangerous Goods Notifications that meet the specified search criteria. The list of Dangerous Goods Notifications complies with the DangerousGoodsNotifications 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.
-
SearchEquipmentTypes
SearchEquipmentTypes(VPCode As String, SpanishDescription As String) As EquipmentTypes.
Searches Equipment types.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-VPCode: Search criteria for the equipment type code. Empty string to retrieve all equipment types.
-SpanishDescription: Search criteria for the equipment spanish description. Empty string to retrieve all equipment types.
Returned values:
-EquipmentTypes: List of Equipment Types that meet the specified search criteria. The list of Equipment types complies with the EquipmentTypes 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.
-
SearchGroupContainerTypes
SearchGroupContainerTypes(GroupType As String, ContainerLength As String, ContainerHeight As String, ContainerType As String, TipoContenedor As String) As GroupContainerTypes.
Searches Container Types according to ISO 6346 Grouped Container Types.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-GroupType: Search criteria for the code of the container type. Empty string to retrieve all codes.
-ContainerLength: Search criteria for container lengths. Available values are (in feet): 20, 40 and 45. Empty string to retrieve all codes.
-ContainerHeight: Search criteria for container heights. Available values are (in feet): 8,5 and 9,5. Empty string to retrieve all codes.
-ContainerType: Search criteria for the english description of the type of container. Empty string to retrieve all entries.
-TipoContenedor: Search criteria for the spanish description of the type of container. Empty string to retrieve all entries.
Returned values:
-GroupContainerTypes: List of Container Type Groups that meet the specified search criteria. The list of Container Type Groups complies with the Group Container Types 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.
-
SearchHullInsurances
SearchHullInsurances(Code As String, Description As String) As HullInsurances.
Searches the Hull insurance companies registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-HullInsurances: List of Hull insurance companies that meet the specified search criteria. The list of Hull insurance companies complies with the Hull Insurances 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.
-
SearchImdg
SearchImdg(FieldName As String, FieldValue As String, Culture As String, SessionTicket As String) As ImdgCodes.
Searches Imdg Dangerous Goods Substances.
This Web Service is restricted to logged users and it requires the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: UNNumber, Variant, Variation, Class, Sublabel1, Sublabel2, ProperShippingName, PackingGroup, EMSNumber,MaritimePollutant, FP, LQ, TechnicalName, TreatAs.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
-Culture: The language of the returned data. It could be ES for Spanish or EN for English.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-ImdgCodes: List of Imdg codes that meet the specified search criteria. The list of Imdg codes complies with the Imdg Codes 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.
-
SearchImdgByService
SearchImdgByService(FieldName As String, FieldValue As String, Culture As String, SessionTicket As String, Service As String) As ImdgCodes.
Searches Imdg Dangerous Goods Substances.
This Web Service is restricted to logged users and it requires the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: UNNumber, Variant, Variation, Class, Sublabel1, Sublabel2, ProperShippingName, PackingGroup, EMSNumber,MaritimePollutant, FP, LQ, TechnicalName, TreatAs.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
-Culture: The language of the returned data. It could be ES for Spanish or EN for English.
-SessionTicket: The Ticket returned by the Login Web Service
-Service: The service that requires the data.
Returned values:
-ImdgCodes: List of Imdg codes that meet the specified search criteria. The list of Imdg codes complies with the Imdg Codes 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.
-
SearchIsoContainerTypes
SearchIsoContainerTypes(ISOType As String, GroupType As String, ContainerLength As String, ContainerHeight As String, ContainerType As String, TipoContenedor As String) As ISOContainerTypes.
Searches Container Types according to ISO 6346 Container Types.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-ISOType: Search criteria for the particular ISO code of the container type. Empty string to retrieve all codes.
-GroupType: Search criteria for the code of the container type group. Empty string to retrieve all codes.
-ContainerLength: Search criteria for container lengths. Available values are (in feet): 20, 40 and 45. Empty string to retrieve all codes.
-ContainerHeight: Search criteria for container heights. Available values are (in feet): 8,5 and 9,5. Empty string to retrieve all codes.
-ContainerType: Search criteria for the english description of the type of container. Empty string to retrieve all entries.
-TipoContenedor: Search criteria for the spanish description of the type of container. Empty string to retrieve all entries.
Returned values:
-ISOContainerTypes: List of Container Types that meet the specified search criteria. The list of Container Types complies with the ISO Container Types 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.
-
SearchIsoCountries
SearchIsoCountries(Code As String, Name As String) As Countries.
Searches the Country codes and descriptions as defined by ISO.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for country code. Empty string to retrieve all countries.
-Name: Search criteria for country name. Empty string to retrieve all countries.
Returned values:
-Contries: List of countries that meet the specified search criteria. The list of countries complies with the Countries 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.
-
SearchLeasingAgents
SearchLeasingAgents(LeasingAgentCode As String, LeasingAgentName As String) As LeasingAgents.
Searches leasing agents.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-LeasingAgentCode: Search criteria for the code assigned to the leasing agent. Empty string to retrieve all entries.
-LeasingAgentName: Search criteria for the name of the leasing agent. Empty string to retrieve all entries.
Returned values:
-LeasingAgents: List of leasing agents (LeasingAgentCode and LeasingAgentName) that meet the specified search criteria. The list of leasing agents complies with the LeasingAgents 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.
-
SearchLocations
SearchLocations(CityCode As String, CityName As String, StateCode As String, StateName As String, CountryCode As String, CountryName As String, IsPort As Integer) As Locations.
Searches UN/Locode ports and locations.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-CityCode: Search criteria for the city/port code (5 characters). Empty string to retrieve all codes.
-CityName: Search criteria for the name of the city/port. Empty string to retrieve all entries.
-StateCode: Search criteria for the State code. Empty string to retrieve all entries.
-StateName: Search criteria for the name of the State. Empty string to retrieve all entries.
-CountryCode: Search criteria for the Country code. Empty string to retrieve all entries.
-CountryName: Search criteria for the name of the Country. Empty string to retrieve all entries.
-IsPort: Flag to limiting the search to ports. Available values: 0 (All locations), 1 (Ports).
Returned values:
-Locations: List of Locations that meet the specified search criteria. The list of Locations complies with the Locations 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.
-
SearchML_MaritimeLine
SearchML_MaritimeLine(MaritimeAgentLineName As String, TerminalCode As String, OrgCode As String) As ML_MaritimeLineCodes.
Searches maritime agent line codes and descriptions .
This Web Service is public and it does not require any previous login to the system.
Parameters:
-MaritimeAgentLineName: Search criteria for the name of the maritime line. Empty string to retrieve all entries.
-TerminalCode: Search criteria for the code of the terminal agent. Empty string to retrieve all entries.
-OrgCode: Search criteria for the code of the cargo agent. Empty string to retrieve all entries.
Returned values:
-ML_MaritimeLineCodes: List of maritime agent lines that meet the specified search criteria. The list of maritime agent lines complies with the ML_MaritimeLineCodes 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.
-
SearchML_MaritimeLines
SearchML_MaritimeLines(lineCode As String, lineName, orgCode As String, cargoTerminalCode As String) As ML_MaritimeLines.
Searches the Maritime Lines codes and descriptions .
Parameters:
-lineCode: Maritime line code
-lineName: Maritime line name
-orgCode: Carrier agent code
-cargoTerminalCode: Cargo terminal code (asign empty string for not cargo terminal search)
Returned values:
-ML_MaritimeLineCodes: List of maritime agent lines that meet the specified search criteria. The list of maritime agent lines complies with the ML_MaritimeLineCodes 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.
-
SearchMaritimeCarriers
SearchMaritimeCarriers(SCAC As String, Name As String, ServiceCode As String) As Carriers.
Searches the Maritime Carrier companies registered by the Valenciaport Portal.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-SCAC: Search criteria for the SCAC (Standard Alpha Code) code. Empty string to retrieve all maritime carriers.
-Name: Search criteria for the Maritime Carrier Name. Empty string to retrieve all maritime carriers.
-ServiceCode: Not used. Preserved for backwards compatibility. Should be an empty string.
Returned values:
-Carriers: List of maritime carrier companies that meet the specified search criteria. The list of Maritime Carrier companies complies with the Carriers 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.
-
SearchOrganizationsByCIF
SearchOrganizationsByCIF(CIF As String) As Parties.
Searches registered Organizations in the Valenciaport Portal given their Spanish Fiscal ID.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CIF: Search criteria for the spanish ID assigned to the organization.
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchOrganizationsByRole
SearchOrganizationsByRole(Code As String, Name As String, RoleCode as String, ServiceCode As String) As Carriers.
Searches registered Organizations with an assigned role in the Valenciaport Portal and returns a DataSet with basic information to be able to send it messages.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the organization. Empty string to retrieve all entries.
-Name: Search criteria for the name of the organization. Empty string to retrieve all entries.
-RoleCode: Code assigned to role within the service. Empty string to retrieve all entries.
-ServiceCode: Code assigned to the service. Empty string to retrieve all entries.
Returned values:
-Carriers: List of Organizations (code, name and mailbox) that meet the specified search criteria. The list of Organizations complies with the Carriers 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.
-
SearchOrganizationsBySICcode
SearchOrganizationsBySICcode(SICcode As String) As Parties.
Searches registered Organizations in the Valenciaport Portal given their code in the previous platform (SIC).
This Web Service is public and it does not require any previous login to the system.
Parameters:
-SICcode: Search criteria for the code used by the organization in previous platform (SIC).
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchOrganizationsWithTicket
SearchOrganizationsWithTicket(Code As String, Name As String, PartyType As String, Ticket As String) As Parties.
Searches registered Organizations in the Valenciaport Portal.
This Web Service requieres a previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the organization. Empty string to retrieve all entries.
-Name: Search criteria for the name of the organization. Empty string to retrieve all entries.
-PartyType: Code assigned to the type of party. Available party type codes are: CA (Carrier), CG (Carrier's Agent), CK (Empty Equipment Party), CN (Consignee), CZ (Shipper), EX (Exporter), FC (Contractor), FW (Freight Forwarder), GO (Goods' Owner), HI (Requestor), NI (Notify Party), PK (Contract Party), TR (Terminal Operator). Empty string to retrieve all entries.
-Ticket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchOrganizationsWithTicketAndCif
SearchOrganizationsWithTicketAndCif(Code As String, Name As String, PartyType As String, Cif as String, Ticket As String) As Parties.
Searches registered Organizations in the Valenciaport Portal.
This Web Service requieres a previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the organization. Empty string to retrieve all entries.
-Name: Search criteria for the name of the organization. Empty string to retrieve all entries.
-PartyType: Code assigned to the type of party. Available party type codes are: CA (Carrier), CG (Carrier's Agent), CK (Empty Equipment Party), CN (Consignee), CZ (Shipper), EX (Exporter), FC (Contractor), FW (Freight Forwarder), GO (Goods' Owner), HI (Requestor), NI (Notify Party), PK (Contract Party), TR (Terminal Operator). Empty string to retrieve all entries.
-Cif: Cif of the party. Empty string to retrieve all entries.
-Ticket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchPackageTypes
SearchPackageTypes(PackageCode As String, UNCode As String, GTNexusCode As String, Description As String, Descripcion As String) As PackageTypes.
Searches the Package Types registered by the Valenciaport Portal, coded according to different systema (Valenciaport Code, UN Recommendation 21, etc.).
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-PackageCode: Search criteria for the Valenciaport Package code (Valenciaport Package codes are UN Rec. 21 codes where available). Empty string to retrieve all codes.
-UNCode: Search criteria for the United Nations Rec. 21 code. Empty string to retrieve all codes.
-GTNexusCode: Search criteria for the GTNexus system code. Empty string to retrieve all codes.
-Description: Search criteria for the english description of package types. Empty string to retrieve all entries.
-Descripcion: Search criteria for the spanish description of package types. Empty string to retrieve all entries.
Returned values:
-PackageTypes: List of Package Types that meet the specified search criteria. The list of Package Types complies with the Package Types 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.
-
SearchPortAuthorityAddressBookParties
SearchPortAuthorityAddressBookParties(Code As String, Name As String, PartyType As String, SessionTicket As String) As Parties.
Searches Organization defined by the Port Authority for its use in the Valenciaport Portal.
This Web Service requires the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the party. Empty string to retrieve all entries.
-Name: Search criteria for the name of the party. Empty string to retrieve all entries.
-PartyType: Code assigned to the type of party. Available party type codes are: CA (Carrier), CG (Carrier's Agent), CK (Empty Equipment Party), CN (Consignee), CZ (Shipper), EX (Exporter), FC (Contractor), FW (Freight Forwarder), GO (Goods' Owner), HI (Requestor), NI (Notify Party), PK (Contract Party), TR (Terminal Operator). Empty string to retrieve all entries.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchPortAuthorityAddressBookPartiesWithCIF
SearchPortAuthorityAddressBookParties(Code As String, Name As String, PartyType As String, SessionTicket As String) As Parties.
Searches Organization defined by the Port Authority for its use in the Valenciaport Portal.
This Web Service requires the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for the code assigned to the party. Empty string to retrieve all entries.
-Name: Search criteria for the name of the party. Empty string to retrieve all entries.
-CIF: Search criteria for then Fiscal code of the party. Empty string to retrieve all entries.
-PartyType: Code assigned to the type of party. Available party type codes are: CA (Carrier), CG (Carrier's Agent), CK (Empty Equipment Party), CN (Consignee), CZ (Shipper), EX (Exporter), FC (Contractor), FW (Freight Forwarder), GO (Goods' Owner), HI (Requestor), NI (Notify Party), PK (Contract Party), TR (Terminal Operator). Empty string to retrieve all entries.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Organizations that meet the specified search criteria. The list of Organizations complies with the Parties 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.
-
SearchQuays
SearchQuays(Port As String, Code As String, Description As String) As Quays.
Searches Port Quays.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Port: The UN/LOCODE code for the Port managed by the Port Authority. Empty string to retrieve all quays.
-Code: Search criteria for the quay code. Empty string to retrieve all quays.
-Description: Search criteria for the quay name. Empty string to retrieve all quays.
Returned values:
-Quays: List of Quays that meet the specified search criteria. The list of Quays complies with the Quays 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.
-
SearchRegularServices
SearchRegularServices(Code As String, Description As String) As RegularServices.
Searches registered Regular Services for Vessel Voyages.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-RegularServices: List of Regular Services that meet the specified search criteria. The list of Regular Services complies with the Regular Services 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.
-
SearchShipOwners
SearchShipOwners(Code As String, Description As String) As ShipOwners.
Searches registered Shipowners for Vessels.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
-APVCode:The APVCode assigned to the organization.
Returned values:
-ShipOwners: List of Shipowners that meet the specified search criteria. The list of Shipowners complies with the Shipowners 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.
-
SearchTARICGoodsCodes
SearchTARICGoodsCodes(CompletedCode As String, Description As String) As TARICGoodsCodes.
Searches TARIC goods codes.
This Web Service is public and it does not require any previous login to the system.
Parameters:
-CompletedCode: Search criteria for the completed code assigned to the TARIC. Empty string to retrieve all entries.
-Description: Search criteria for the description of the TARIC. Empty string to retrieve all entries.
Returned values:
-TARICGoodsCodes: List of TARIC codes (CompletedCode and Description) that meet the specified search criteria. The list of TARIC codes complies with the TARICGoodsCodes 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.
-
SearchTerminalsAndLocations
SearchTerminalsAndLocations(ByVal FieldName As String, ByVal FieldValue As String) As TerminalsAndLocations.
Searches Terminals And Locations.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: Code and Description.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
Returned values:
-TerminalsAndLocations: List of Terminals And Locations that meet the specified search criteria. The list of Terminals And Locations complies with the Terminals And Locations 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.
-
SearchTrains
SearchTrains(FieldName As String, FieldValue As String) As Trains.
Searches the Vessel Files registered by the Port Authority.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: TrainServiceCode, RailDepartureDate, RailCompanyCode, RailCompanyName, OriginTerminalCode and DestinationTerminalName.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
Returned values:
-Trains: List of Trains that meet the specified search criteria. The list of Trains complies with the Trains 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.
-
SearchVesselClassificationSocieties
SearchVesselClassificationSocieties(Code As String, Description As String) As VesselClassificationSocieties.
Searches the Vessel Classification Societies registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-VesselClassificationSocieties: List of Vessel Classification Societies that meet the specified search criteria. The list of Vessel Classification Societies complies with the Vessel Classification Societies 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.
-
SearchVesselPortAgents
SearchVesselPortAgents(FieldName As String, FieldValue As String, CallReference As String, Departure As Boolean, SessionTicket As String) As Parties.
Searches Vessel Port Agents.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: CompanyCode, CIF, CompanyName.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
-CallReference: Reference of vessel call.
-Departure: Indicates if Cargo Agent is to the arrival or departure in the Call Request.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Parties: List of Vessel Port Agents that meet the specified search criteria. The list of Vessel Port Agents complies with the Parties 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(FieldName As String, FieldValue As String, VesselAgentCIF As String, CargoAgentCIF As String, Departure As Boolean, SessionTicket As String) As VesselPortCallsLookup.
Searches Vessel Port Calls.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: CallReference, IMONumber, VesselName, VesselFlag, VesselFlagDescription, VesselAgentCode, VesselAgentNIF, VesselAgentName, ETA,ETD,VoyageNumber, PreviousPortOfCall, PrevPortOfCallName, NextPortOfCall, NextPortOfCallName and Status.
-FieldValue: Search criteria for the field name. Empty string to retrieve all entries.
-VesselAgentCIF: Fiscal code of the Vessel Agent that presented the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-CargoAgentCIF: Fiscal code of the Cargo Agent that it is included in the Call Request. This parameter is optional, if it is left in blank this method will not search the Vessel Call by this parameter.
-Departure: Indicates if Cargo Agent is to the arrival or departure in the Call Request.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-VesselPortCallsLookup: List of Vessel Port Calls that meet the specified search criteria. The list of Vessel Port Calls complies with the VesselPortCallsLookup 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.
-
SearchVesselTypes
SearchVesselTypes(Code As String, Description As String) As VesselTypes.
Searches the Vessel Types registered by the Port Authority.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Code: Search criteria for code. Empty string to retrieve all codes.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-VesselTypes: List of Vessel Types that meet the specified search criteria. The list of Vessel Types complies with the Vessel Types 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.
-
SearchVessels
SearchVessels(FieldName As String, FieldValue As String) As Vessels.
Searches the Vessel Files registered by the Port Authority.
This Web Service is restricted to logged users and it requires the the use of the Ticket returned by the login service.
All searches use a beginning with criteria.
Parameters:
-FieldName: Name of the field to search. Available FieldNames are: IMO, VesselName, CallSign, FlagCode, FlagName, ShipOwnerCode, ShipOwner, VesselTypeCode, VesselType, PortOfRegistryCode and PortOfRegistry.
-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.
-
SearchWarehouse
SearchWarehouse(Port As String, Code As String, Description As String) As Quays.
Searches Warehouse.
This Web Service is public and it does not require any previous login to the system.
All searches use a beginning with criteria.
Parameters:
-Port: The UN/LOCODE code for the Port managed by the Port Authority. Empty string to retrieve all Warehouse.
-Code: Search criteria for the Warehouse code. Empty string to retrieve all Warehouse.
-Description: Search criteria for the Warehouse name. Empty string to retrieve all Warehouse.
Returned values:
-Warehouse: List of Warehouse that meet the specified search criteria. The list of Warehouse complies with the Warehouse 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.
-
SearchWasteCompanies
SearchWasteCompanies(Code As String, ByVal CIF As String,, Description As String) As WasteCompanies.
Parameters:
-CIF: Search criteria for CIF. Empty string to retrive all CIFS.
-Description: Search criteria for description. Empty string to retrieve all descriptions.
Returned values:
-WasteCompanies: List of Port Waste Companies that meet the specified search criteria. The list of Waste Companies complies with the WasteCompanies 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.