SteinService Web Service

SteinService

Click here for a complete list of operations.

GetContainerListOrderByStatus

GetContainerListOrderByStatus(ByVal Status As String, ByVal SelectedView As String, ByVal Archived As Integer, ByVal SessionTicket As String, ByVal FilterNumber As Integer) As SteinDataset.
Returns a list of Container List Order in a given status when the user is acting in a given Role.

The user must have VIEW rights over the service.

Parameters:
-Status: Status of the requested documents. Available status codes are: ALL (All document status), DRA (Draft), SEN (Sent), ACE Accepted, DEN (Denied), CAN (Cancelled), REJ (Rejected), AUT (Authorised), DEO (Departure Denied), AUO (Departure Authorised), ACR Conditionally Accepted, TEM (Template).
-SelectedView: The role in which the user is acting. Available role codes are: SENDR (Sender of Container List Order 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
-FilterNumber: Documents number to return

Returned values:
-Table of documents: List of documents that comply with the search criteria according to the Container List Order 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/GetContainerListOrderByStatus"

<?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>
    <GetContainerListOrderByStatus xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <Status>string</Status>
      <SelectedView>string</SelectedView>
      <Archived>int</Archived>
      <SessionTicket>string</SessionTicket>
      <FilterNumber>int</FilterNumber>
    </GetContainerListOrderByStatus>
  </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>
    <GetContainerListOrderByStatusResponse xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <GetContainerListOrderByStatusResult>dataset</GetContainerListOrderByStatusResult>
    </GetContainerListOrderByStatusResponse>
  </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>
    <GetContainerListOrderByStatus xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <Status>string</Status>
      <SelectedView>string</SelectedView>
      <Archived>int</Archived>
      <SessionTicket>string</SessionTicket>
      <FilterNumber>int</FilterNumber>
    </GetContainerListOrderByStatus>
  </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>
    <GetContainerListOrderByStatusResponse xmlns="http://tempuri.org/Valenciaport.Services/Stein">
      <GetContainerListOrderByStatusResult>dataset</GetContainerListOrderByStatusResult>
    </GetContainerListOrderByStatusResponse>
  </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/GetContainerListOrderByStatus?Status=string&SelectedView=string&Archived=string&SessionTicket=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>