SteinService
The following operations are supported. For a formal definition, please review the Service Description.
-
ActivateCoplistDocument
ActivateCoplistDocument(ByVal ContainerListDocumentGUID As String, ByVal SessionTicket As String) As Boolean.
Activation of a Container List Document which has been previously archived.
The user must have CHANGE rights over the document.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
True: Operation successfully completed.
False: Operation has not been executed.
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.
-
ActivateCopordDocument
ActivateCopordDocument(ByVal ContainerListOrderDocumentGUID As String, ByVal SessionTicket As String) As Boolean.
Activation of a Container List Order Document which has been previously archived.
The user must have CHANGE rights over the document.
Parameters:
-ContainerListOrderDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
True: Operation successfully completed.
False: Operation has not been executed.
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.
-
ArchiveCoplistDocument
ArchiveCoplistDocument(ByVal ContainerListDocumentGUID As String, ByVal SessionTicket As String) As Boolean.
Archiving of a Container List Document.
Archives information about Container List Document.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
True: Operation successfully completed.
False: Operation has not been executed.
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.
-
ArchiveCopordDocument
ArchiveCopordDocument(ByVal ContainerListOrderDocumentGUID As String, ByVal SessionTicket As String) As Boolean.
Archiving of a Container List Order Document.
Archives information about Container List Order Document.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListOrderDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
True: Operation successfully completed.
False: Operation has not been executed.
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.
-
CopyContainerListDocument
CopyContainerListDocument(ByVal ContainerListGUID As System.Guid, ByVal Status As String, ByVal SessionTicket As String) As String.
Returns a copy of an existing Container List Document in a given status for its use as a new Container List Document (MessageFunction=9 -Original-) in a given Status.
The returned document is compliant with the Container List Schema and the Container List user guide.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-Status: The Status of the new Container List Document.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Wasdis document: The copy of the given Container List Document Reference.
-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.
-
CopyContainerListOrderDocument
CopyContainerListOrderDocument(ByVal ContainerListOrderGUID As System.Guid, ByVal SessionTicket As String) As String.
Returns a copy of an existing Container List Order Document in a given status for its use as a new Container List Order Document (MessageFunction=9 -Original-) in a given Status.
The returned document is compliant with the Container List Order Schema and the Container List Order user guide.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListOrderDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Wasdis document: The copy of the given Container List Order Document Reference.
-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.
-
DeleteContainerList
DeleteContainerList(ByVal ContainerListGUID As System.Guid, ByVal SessionTicket As String) As Boolean.
Deletes a Container List Document previously submitted which must be in a Draft or Template status.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
DeleteContainerListOrder
DeleteContainerListOrder(ByVal ContainerListOrderGUID As System.Guid, ByVal SessionTicket As String) As Boolean.
Deletes a Container List Order Document previously submitted which must be in a Draft or Template status.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListOrderDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
GetContainerListByOwnerCallReferenceOpType
GetContainerListByStatus(ByVal Status As String, ByVal SelectedView As String, ByVal Archived As Integer, ByVal SessionTicket As String, ByVal FilterNumber As Integer) As SteinDataset.
Returns a Container List in a given Equipment Reference, Vessel Por Call Reference and Operation Type.
The user must have VIEW rights over the service.
Parameters:
-CarrierAgent: The CIF of the Vessel Agent.
-VesselPortCall: The Vessel Por Call.
-OperationType: Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-TerminalAgent: The CIF of the Terminal Agent.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Requested: A Container List 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.
-
GetContainerListByStatus
GetContainerListByStatus(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 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 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 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.
-
GetContainerListContext
GetContainerListContext(ByVal ContainerListDocumentGUID As Guid, ByVal SessionTicket As String) As String.
Returns the context of a Container List Document given its unique reference.
The Container List Context allows to know the status of the Container List and of the related equipments. The Container List is compliant with the Container List schema.
The user must have VIEW rights over the service.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Request: The requested Container List Document.
-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.
-
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.
-
GetContainerListOrderContext
GetContainerListOrderContext(ByVal ContainerListOrderDocumentGUID As Guid, ByVal SessionTicket As String) As String.
Returns the context of a Container List Order Document given its unique reference.
The Container List Order Context allows to know the status of the Container List Order and of the related equipments. The Container List Order is compliant with the Container List Order schema.
The user must have VIEW rights over the service.
Parameters:
-ContainerListOrderDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Order Request: The requested Container List Order Document.
-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.
-
GetCoprarDocument
GetCoprarDocument(ByVal ContainerListDocumentGUID As String, ByVal MessageType As String, ByVal SessionTicket As String) As String.
Returns an existing Container List Document or Container List Order Document given its unique reference.
The returned document is compliant with the Container List Xml Schema or the Container List Order Xml Schema and the Container List user guide or the Container List Order user guide.
The user must have VIEW rights over the service.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Document or the the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListByStatus or the GetContainerListOrderByStatus method.
-MessageType:Message Type of the Document. Available message type codes are: COPLIS (Container List) and COPORD (Container List Order).
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Document: The requested Container List Document.
-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.
-
GetCoprarHeaderDocument
GetCoprarHeaderDocument(ByVal ContainerListDocumentGUID As String, ByVal MessageType As String, ByVal SessionTicket As String) As String.
Returns the header of an existing Container List Document given its unique reference.
The returned document is compliant with the Container List Xml Schema and the Berman user guide.
The user must have VIEW rights over the service.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-MessageType:Message Type of the Document. Available message type codes are: COPLIS (Container List) and COPORD (Container List Order)
.-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Document Header: The header of the requested Container List Document.
-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.
-
GetEquipmentContent
GetEquipmentContent(ByVal ContainerNumber As String, ByVal VesselPortCall As String, ByVal OperationType As String, ByVal TerminalAgent As String, ByVal SessionTicket As String) As String.
Returns the content of an equipment in a given search criteria.
The user must have VIEW rights over the service.
Parameters:
-ContainerNumber: Reference to the requested equipment.
-VesselPortCall: The Vessel Por Call.
-OperationType: Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-TerminalAgent: The CIF of the Terminal Agent.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Equipment Content: The requested equipment content.
-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.
-
GetEquipmentCustomsDocuments
GetEquipmentCustomsDocuments(ByVal EquipmentID As String, ByVal VesselPortCall As String, ByVal OperationType As String, ByVal SessionTicket As String) As String.
Returns a List of Equipment Custom Documents of a given Equipment Reference, Vessel Port Call Reference and Operation Type.
The user must have VIEW rights over the service.
Parameters:
-EquipmentID : The Equipment Reference.
-VesselPortCall: The Vessel Por Call.
-OperationType: Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-List of Equipment Custom Documents: List of Equipment Custom Documents of the Equipment requested 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.
-
GetEquipmentSummary
GetEquipmentSummary(ByVal VesselPortCall As String, ByVal TerminalCode As String, ByVal ContainerStatus As String, ByVal DocumentStatus As String, ByVal ListType As String, ByVal DrafId As String, ByVal DrafMsgType As String, ByVal SummaryType As String, ByVal SessionTicket As String) As RecapitulativeDataset.
Returns Recapitulative information about equipment that in a given Vessel Port Call Reference, Terminal Estevedoring, equipment status and document status .
The user must have VIEW rights over the service.
Parameters:
-VesselPortCall: The Vessel Por Call.
-TerminalCode: The Code of the Terminal Estividoring.
-ContainerStatus: Status Code of the containers in the equipment list. Available container status codes are:INC (included), CNF (Confirmed) and REG (Registred).
-DocumentStatus: Status Code of the Stein documents.
-ListType : List Type of the Document. Available List type codes are: (), () and ().
-DrafId: Document number if Document is in Draft Status.
-DrafMsgType: Draft Message Type of the Document. Available message type codes are: LE (Container List), LO (Container List Order) and LP (COPCON).
-SummaryType: Summary Type Code. Available message type codes are: APV (Authority Port of Valencia).
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Table of Equipment Summary: List of Summary information that have received within a given parameters according to the RecapitulativeDataset 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.
-
GetEquipmentTVA
GetEquipmentTVAZipped(ByVal CallReference As String, ByVal AgentCode As String, ByVal ShippingLine As String, ByVal TerminalCode As String, ByVal ListType As String, ByVal SessionTicket As String) As String.
Returns the TVA justification model of an organization .
The user must have VIEW rights over the service.
Parameters:
-CallReference: Number assigned by the Port Authority to represent the Vessel Call.
-AgentCode: Carrier Agent Code of the equipment.
-ShippingLine: Shipping Line Code of the equipment.
-TerminalCode: Container Terminal Code.
-ListType : Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Table of TVA justifications: List of TVA justification model information according to the TVAData 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.
-
GetEquipmentTVAZipped
GetEquipmentTVAZipped(ByVal CallReference As String, ByVal AgentCode As String, ByVal ShippingLine As String, ByVal TerminalCode As String, ByVal ListType As String, ByVal SessionTicket As String) As String.
Returns the TVA justification model of an organization .
The user must have VIEW rights over the service.
Parameters:
-CallReference: Number assigned by the Port Authority to represent the Vessel Call.
-AgentCode: Carrier Agent Code of the equipment.
-ShippingLine: Shipping Line Code of the equipment.
-TerminalCode: Container Terminal Code.
-ListType : Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Table of TVA justifications: List of TVA justification model information according to the TVAData 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.
-
GetEquipmentsContext
GetEquipmentsContext(ByVal VesselAgent As String, ByVal CarrierAgent As String, ByVal VesselPortCall As String, ByVal OperationType As String, ByVal TerminalAgent As String, ByVal SessionTicket As String) As String.
Returns a list of Equipment Context given a search criteria.
The user must have VIEW rights over the service.
Parameters:
-VesselAgent: The CIF of the Vessel Agent.
-CarrierAgent: The CIF of the Vessel Agent.
-VesselPortCall: The Vessel Por Call.
-OperationType: Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-TerminalAgent: The CIF of the Terminal Agent.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-List of Equipments: List of equipments 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.
-
GetSteinDocumentAuditList
GetSteinDocumentAuditList(ByVal Reference As String, ByVal SelectedView As String, ByVal SessionTicket As String, ByVal MessageType As String, ByVal DocumentSender As String) As AuditMessages.
Returns a list of all messages sent or received for a given Container List Document when the user is acting in a given Role.
The user must have VIEW rights over the service.
Parameters:
-Reference: Unique reference to the Container List Document. The unique reference of the document could be retrieved from the GetContainerListByStatus methods.
-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).
-SessionTicket: The Ticket returned by the Login Web Service
-MessageType: Message Type of the Document. Available message type codes are: COPLIS (Container List) and COPORD (Container List Order).
-DocumentSender: Organization who sent the document.
Returned values:
-Table of audited messages: List of messages that have been sent or received within a given reference according to the Audit Messages List 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.
-
GetSteinDocumentAuditMessage
GetSteinDocumentAuditMessage(ByVal SteinDocumentGUID As String, ByVal SessionTicket As String) As String.
Returns a message sent or received for a given Container List Document.
The user must have VIEW rights over the service.
Parameters:
-SteinDocumentGUID: Unique reference to the Container List Document. The unique reference of the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Audited messages: Message that have been sent or received within a given reference according to the Audit Messages List 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.
-
GetSteinDocumentStatus
GetSteinDocumentStatus(ByVal DocumentNumber As String, ByVal OrganizationCode As String, ByVal MessageType As String) As String.
Returns the status code for a given Document Reference, Organization Code and Message Type.
The user must have VIEW rights over the service.
Parameters:
-DocumentNumber: Unique reference to the Container List Document. The unique reference of the document could be retrieved from the GetContainerListByStatus method.
-OrganizationCode: The Organization Code who owns de document.
-MessageType: Message Type of the Document. Available message type codes are: LE (Container List), LO (Container List Order) and LP (COPCON).
Returned values:
-Status: Status of the Requeted Document. Available message type codes are:
-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.
-
GetT2LAuthorizationCode
GetT2LAuthorizationCode(SessionTicket as String) As String.
Gets T2L process authorization number of user logged
This Web Service is restricted to authorised logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-SessionTicket: The ticket returned by the login service.
Returned values:
-StringT2L process authorization number.
-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.
-
NewContainerListDocumentFromTemplate
NewContainerListDocumentFromTemplate(ByVal templateGUID As String, ByVal SessionTicket As String) As String.
Returns a copy of a previously saved template Container List Document in a draft status.
The returned document is compliant with the Container List Xml Schema and the Container List user guide.
The user must have CHANGE rights over the service.
Parameters:
-templateGUID: Unique reference to the Container List Document. The unique reference to the document could be retrieved from the GetContainerListByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Document: A copy of the given Container List Template Document.
-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.
-
NewContainerListOrderContextFromCallReference
NewContainerListOrderContextFromCallReference(ByVal CallReference As String, ByVal OperationType As String, ByVal TerminalAgent As String, ByVal SessionTicket As String) As String.
Returns a new Container List Document copying a List of Equipments by a given Vessel Port Call Reference and an Operation Type.
The returned document is compliant with the Container List Order Xml Schema and the Container List Order user guide.
The user must have CHANGE rights over the service.
Parameters:
-CallReference: Number assigned by the Port Authority to represent the Vessel Call.
-OperationType: Operation Type of the Document. Available List type codes are: 118 () and 121 ().
-TerminalAgent: The CIF of the Terminal Agent.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Document: A new Container List Order Document.
-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.
-
NewContainerListOrderDocumentFromTemplate
NewContainerListOrderDocumentFromTemplate(ByVal templateGUID As String, ByVal SessionTicket As String) As String.
Returns a copy of a previously saved template Container List Order Document in a draft status.
The returned document is compliant with the Container List Order Xml Schema and the Container List Order user guide.
The user must have CHANGE rights over the service.
Parameters:
-templateGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Order Document: A copy of the given Container List Order Template Document.
-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.
-
NewContainerListOrderHeaderFromCallReference
NewContainerListOrderHeaderFromCallReference(ByVal CallReference As String, ByVal OperationType As String, ByVal TerminalAgent As String, ByVal SessionTicket As String) As String.
Returns the header of an existing Container List Order Document given its unique reference.
The returned document is compliant with the Container List Order Xml Schema and the Container List Order user guide.
The user must have VIEW rights over the service.
Parameters:
-ContainerListDocumentGUID: Unique reference to the Container List Order Document. The unique reference to the document could be retrieved from the GetContainerListOrderByStatus method.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-Container List Document Header: The header of the requested Container List Document.
-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.
-
SaveContainerListDocumentAsTemplate
SaveContainerListDocumentAsTemplate(ByVal ContainerListDocument As String, ByVal DocumentNumber As String, ByVal SessionTicket As String) As Boolean.
Saves a Container List Document as a Template.
The user must have CHANGE rights over the service.
Parameters:
-ContainerListDocument: The Container List Document which will be saved as a template. The document should be compliant with the Container List Xml Schema and the Container List user guide.
-DocumentNumber: The Document Number of the given Container List Document to save with.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
SaveContainerListOrderDocumentAsTemplate
SaveContainerListOrderDocumentAsTemplate(ByVal XmlContainerListOrderDocument As String, ByVal DocumentNumber As String, ByVal SessionTicket As String) As Boolean.
Saves a Container List Order Document as a Template.
The user must have CHANGE rights over the service.
Parameters:
-XMLContainerListOrderDocument: The Container List Order message which will be sent. The document should be strictly compliant with the Container List Order Schema and the Container List Order user guide. If the message has syntactic, semantic or business errors, they will be detailed in the AlarmList result
-DocumentNumber: The Document Number of the given Container List Order Document to save with.
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
SaveCoplistDocument
SaveCoplistDocument(ByVal XMLContainerListDocument As String, ByVal SessionTicket As String, ByVal currentStatus As String, ByRef DocumentNumber As String) As Boolean.
Saves a Container List Document which must be in a Draft or Template status.
The user must have CHANGE rights over the service.
Parameters:
-XMLContainerListDocument: The Container List Request Document which will be saved. The document should be compliant with the Container List Xml Schema and the Container List user guide.
-SessionTicket: The Ticket returned by the Login Web Service
-currentStatus: The current status of the Container List Document given
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
SaveCopordDocument
SaveCopordDocument(ByVal XMLContainerListOrderDocument As String, ByVal SessionTicket As String, ByVal currentStatus As String, ByRef DocumentNumber As String) As Boolean.
Saves a Container List Order Document which must be in a Draft or Template status.
The user must have CHANGE rights over the service.
Parameters:
-XMLContainerListOrderDocument: The Container List Order Request Document which will be saved. The document should be compliant with the Container List Order Xml Schema and the Container List Order user guide.
-SessionTicket: The Ticket returned by the Login Web Service
-currentStatus: The current status of the Container List Order Document given
Returned values:
-True: Operation successfully completed.
-False: Operation has not been executed.
-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.
-
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.
-
SearchContainerListOrderListByStatus
SearchContainerListOrderListByStatus(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 Order 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 Order 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 Order 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.
-
SearchEquipmentsContext
SearchEquipmentsContext(VesselAgent As String, CarrierAgent As String, VesselPortCall As String, OperationType As String, TerminalAgent As String, ContainerNumber As String, Status As String, FullOrEmpty As String, SessionTicket As String) As String.
Returns a list of equipments that comply with the search criteria.
This Web Service is restricted to authorised logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-VesselAgent: Vessel agent code.
-CarrierAgent: Cargo agent code.
-VesselPortCall: Vessel port call reference number.
-OperationType: Operation type ( 118 = Import, 121 = Export).
-TerminalAgent: Terminal operator code.
-ContainerNumber: Container number.
-Status: Status code (3 = Import, 2 = Export, R = Shifter, T = Transhipment, S = No shifter).
-FullOrEmpty: Full or empty indicator code ( 4 = Empty, F = Full).
-SessionTicket: The ticket returned by the login service.
Returned values:
-String: List of equipments zipped into string. The data must comply with the Stein 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.
-
SendContainerListDocument
SendContainerListDocument(ByVal XMLContainerListDocument As String, ByVal SessionTicket As String, ByVal DocumentName As String) As AlarmList.
Sends a Container List Document or replace (Message Function 5) or cancellation (Message Function 1) message.
The user must have CHANGE rights over the service.
Parameters:
-XMLContainerListDocument: The Container List message which will be sent. The document should be strictly compliant with the Container List Schema and the Container List user guide. If the message has syntactic, semantic or business errors, they will be detailed in the AlarmList result
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-List of errors: A list of issues that do not allow the transmission of the message. The list of errors is returned according to the Alarm List schema. The list will be empty if the message is succesfully transmitted.
-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.
-
SendContainerListOrderDocument
SendContainerListOrderDocument(ByVal XMLContainerListOrderDocument As String, ByVal SessionTicket As String, ByVal DocumentName As String) As AlarmList.
Sends a Container List Order Document or replace (Message Function 5) or cancellation (Message Function 1) message.
The user must have CHANGE rights over the service.
Parameters:
-XMLContainerListOrderDocument: The Container List Order message which will be sent. The document should be strictly compliant with the Container List Order Schema and the Container List Order user guide. If the message has syntactic, semantic or business errors, they will be detailed in the AlarmList result
-SessionTicket: The Ticket returned by the Login Web Service
Returned values:
-List of errors: A list of issues that do not allow the transmission of the message. The list of errors is returned according to the Alarm List schema. The list will be empty if the message is succesfully transmitted.
-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.
-
UpdateT2LAuthorization
UpdateT2LAuthorization(data As T2LData, CallReference As String, TerminalAgent As String, SessionTicket as String) As Boolean.
Update containers T2L authorization by logged organization
This Web Service is restricted to authorised logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-data:List of containers with their T2L authorization numbers
-CallReference:Vessel port call reference to load containers
-TerminalAgent:Loading Terminal Agent Code
-SessionTicket: The ticket returned by the login service.
Returned values:
-Boolean Identifies if T2L authorization of containers has been updated.
-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.
-
UpdateTranshipmentAuthorization
UpdateTranshipmentAuthorization(data As TBDAData, CallReference As String, TerminalAgent As String, SessionTicket as String) As Boolean.
Update containers transhipment authorization by logged organization
This Web Service is restricted to authorised logged users and it requires the use of the Ticket returned by the login service.
Parameters:
-data:List of containers with their transhipment discharge summary
-CallReference:Vessel port call reference to load containers
-TerminalAgent:Loading Terminal Agent Code
-SessionTicket: The ticket returned by the login service.
Returned values:
-Boolean Identifies if transhipment authorization of containers has been updated.
-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.