SteinService


Click here for a complete list of operations.

SearchContainerListByStatus

SearchContainerListByStatus(ByVal FieldCode As String, ByVal FieldValue As String, ByVal Status As String, ByVal SelectedView As String, ByVal Archived As Integer, ByVal SessionTicket As String, ByVal filter As String, ByVal dFrom As String, ByVal dTo As String, ByVal FilterNumber As Integer) As SteinDataset.
Returns a list of Container List Documents that complies with the search criteria when the user is acting in a given Role.

The user must have VIEW rights over the service.

Parameters:
-FieldCode: The code of the field to initiate the search. Available field codes are: ,,,..
-FieldValue: The value of the field to search. The search of text is according to beginning with criteria for text or greater than for dates.
-Status: Status of the Container List documents. Available status codes are: ALL (All document status), DRA (Draft), SEN (Sent), ACE Accepted, CAN (Cancelled), REJ (Rejected), TEM (Template).
-SelectedView: The role in which the user is acting. Available role codes are: SENDR (Sender of Container List Documents), RECVR (Receiver of Container List Documents).
-Archived: Flag indicating if the requested documents are active or archived. Available archived codes are: 0 (Active), 1 Archived.
-SessionTicket: The Ticket returned by the Login Web Service
-filter:
-dFrom:
-dTo:
-FilterNumber: Documents number to return

Returned values:
-Table of documents: List of documents that comply with the search criteria according to the SteinDataset schema. The list could be empty.
-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/stein.asmx HTTP/1.1
Host: stein.valenciaportpcs.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/Valenciaport.Services/Stein/SearchContainerListByStatus"

<?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>
    <SearchContainerListByStatus xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <FieldCode>string</FieldCode>
      <FieldValue>string</FieldValue>
      <Status>string</Status>
      <SelectedView>string</SelectedView>
      <Archived>int</Archived>
      <SessionTicket>string</SessionTicket>
      <filter>string</filter>
      <dFrom>string</dFrom>
      <dTo>string</dTo>
      <FilterNumber>int</FilterNumber>
    </SearchContainerListByStatus>
  </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>
    <SearchContainerListByStatusResponse xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <SearchContainerListByStatusResult>dataset</SearchContainerListByStatusResult>
    </SearchContainerListByStatusResponse>
  </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/stein.asmx HTTP/1.1
Host: stein.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>
    <SearchContainerListByStatus xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <FieldCode>string</FieldCode>
      <FieldValue>string</FieldValue>
      <Status>string</Status>
      <SelectedView>string</SelectedView>
      <Archived>int</Archived>
      <SessionTicket>string</SessionTicket>
      <filter>string</filter>
      <dFrom>string</dFrom>
      <dTo>string</dTo>
      <FilterNumber>int</FilterNumber>
    </SearchContainerListByStatus>
  </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>
    <SearchContainerListByStatusResponse xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <SearchContainerListByStatusResult>dataset</SearchContainerListByStatusResult>
    </SearchContainerListByStatusResponse>
  </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/stein.asmx/SearchContainerListByStatus?FieldCode=string&FieldValue=string&Status=string&SelectedView=string&Archived=string&SessionTicket=string&filter=string&dFrom=string&dTo=string&FilterNumber=string HTTP/1.1
Host: stein.valenciaportpcs.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

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