LookUp
Click here for a complete list of operations.
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.
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/SearchOrganizationsByRole" <?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> <SearchOrganizationsByRole xmlns="http://tempuri.org/Services/LookUp"> <Code>string</Code> <Name>string</Name> <RoleCode>string</RoleCode> <ServiceCode>string</ServiceCode> </SearchOrganizationsByRole> </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> <SearchOrganizationsByRoleResponse xmlns="http://tempuri.org/Services/LookUp"> <SearchOrganizationsByRoleResult>dataset</SearchOrganizationsByRoleResult> </SearchOrganizationsByRoleResponse> </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> <SearchOrganizationsByRole xmlns="http://tempuri.org/Services/LookUp"> <Code>string</Code> <Name>string</Name> <RoleCode>string</RoleCode> <ServiceCode>string</ServiceCode> </SearchOrganizationsByRole> </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> <SearchOrganizationsByRoleResponse xmlns="http://tempuri.org/Services/LookUp"> <SearchOrganizationsByRoleResult>dataset</SearchOrganizationsByRoleResult> </SearchOrganizationsByRoleResponse> </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/SearchOrganizationsByRole?Code=string&Name=string&RoleCode=string&ServiceCode=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"?> <Carriers xmlns="http://tempuri.org/Services/LookUp">dataset</Carriers>