SOAP Class

Properties   Methods   Events   Config Settings   Errors  

The SOAP Class is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.

Syntax

class ipworksssl.SOAP

Remarks

The SOAP Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config method.

The SOAP Class implements a standard SOAP client as specified in the SOAP 1.1 specification.

The class uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP method and method_uri, as well as optional parameters in the params properties. Then set the target url and call the send_request method.

The results will be provided through the return_value property and the params properties (for output parameters). Additionally, properties such as xpath, x_element, x_text, etc. allow for more granular traversal of the SOAP response.

If the server returns an error, the fault_code, fault_string, and fault_actor properties will provide information about the error condition.

The class may also be used in offline mode. This is supported by methods such as build_packet and eval_packet. The corresponding SOAP packet will be stored in the soap_packet property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the soap_packet. The send_packet method may then be used to send the custom-created soap_packet to the destination url.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

accept Property

This property includes a list of acceptable MIME types for the request.

Syntax

def get_accept() -> str: ...
def set_accept(value: str) -> None: ...

accept = property(get_accept, set_accept)

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

action_uri Property

The value of the SOAP-Action header.

Syntax

def get_action_uri() -> str: ...
def set_action_uri(value: str) -> None: ...

action_uri = property(get_action_uri, set_action_uri)

Default Value

""

Remarks

When the method_uri or method properties are set, the action_uri property is automatically updated to method_uri#method.

authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

auth_scheme Property

The authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

Note: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

connected Property

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

content_type Property

Content type for SOAP request data.

Syntax

def get_content_type() -> str: ...
def set_content_type(value: str) -> None: ...

content_type = property(get_content_type, set_content_type)

Default Value

"text/xml"

Remarks

The default value for content_type is "text/xml".

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

cookie_domain Property

This is the domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

This property contains an expiration time for the cookie (if provided by the server).

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

This property, contains the name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

This property contains the security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

This property contains the value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

fault_actor Property

Actor of any faults returned by the SOAP server.

Syntax

def get_fault_actor() -> str: ...

fault_actor = property(get_fault_actor, None)

Default Value

""

Remarks

fault_code and fault_string provide the corresponding fault code and description.

This property is read-only.

fault_code Property

Code of any faults returned by the SOAP server.

Syntax

def get_fault_code() -> str: ...

fault_code = property(get_fault_code, None)

Default Value

""

Remarks

fault_string and fault_actor provide the corresponding fault description and actor.

This property is read-only.

fault_string Property

Textual description of any faults returned by the SOAP server.

Syntax

def get_fault_string() -> str: ...

fault_string = property(get_fault_string, None)

Default Value

""

Remarks

fault_code and fault_actor provide the corresponding fault code and actor.

This property is read-only.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

This property determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

if_modified_since Property

This property includes a date determining the maximum age of the desired document.

Syntax

def get_if_modified_since() -> str: ...
def set_if_modified_since(value: str) -> None: ...

if_modified_since = property(get_if_modified_since, set_if_modified_since)

Default Value

""

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class fails with an error

The format of the date value for if_modified_since is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

local_file Property

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through transferred_data and the on_transfer event.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

method Property

The remote Method .

Syntax

def get_method() -> str: ...
def set_method(value: str) -> None: ...

method = property(get_method, set_method)

Default Value

""

Remarks

When the method_uri or method properties are set, the action_uri property is automatically updated to method_uri#method.

method_uri Property

The URI corresponding to the SOAP Method .

Syntax

def get_method_uri() -> str: ...
def set_method_uri(value: str) -> None: ...

method_uri = property(get_method_uri, set_method_uri)

Default Value

""

Remarks

When the method_uri or method properties are set, the action_uri property is automatically updated to method_uri#method.

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

The array indices start at 0 and end at namespace_count - 1.

namespace_prefix Property

The Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

The namespace_prefix for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

Namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

Namespace URI associated with the corresponding namespace_prefix. This is usually a URL pointing to the XML schema for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

param_count Property

The number of records in the Param arrays.

Syntax

def get_param_count() -> int: ...
def set_param_count(value: int) -> None: ...

param_count = property(get_param_count, set_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• param_attrs
• param_name
• param_value

The array indices start at 0 and end at param_count - 1.

param_attrs Property

Extra attributes for the parameter.

Syntax

def get_param_attrs(param_index: int) -> str: ...
def set_param_attrs(param_index: int, value: str) -> None: ...

Default Value

""

Remarks

Extra attributes for the parameter.

The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.

param_name Property

The name of the Method parameter.

Syntax

def get_param_name(param_index: int) -> str: ...
def set_param_name(param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the method parameter.

The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.

param_value Property

The value of the Method parameter.

Syntax

def get_param_value(param_index: int) -> str: ...
def set_param_value(param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the method parameter.

The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

This property includes a password if authentication is to be used.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

pragma Property

This property includes a browser- or server-specific header line (optional).

Syntax

def get_pragma() -> str: ...
def set_pragma(value: str) -> None: ...

pragma = property(get_pragma, set_pragma)

Default Value

""

Remarks

If this property contains a nonempty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation. It can be used to send or receive proprietary information to or from the server.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

referer Property

This property includes the referer URL/document (optional).

Syntax

def get_referer() -> str: ...
def set_referer(value: str) -> None: ...

referer = property(get_referer, set_referer)

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

return_value Property

Value returned by the SOAP Method .

Syntax

def get_return_value() -> str: ...

return_value = property(get_return_value, None)

Default Value

""

Remarks

return_value corresponds to the first item in the params properties.

This property is read-only.

soap_encoding Property

The type of SOAP Encoding used for SOAP requests.

Syntax

def get_soap_encoding() -> str: ...
def set_soap_encoding(value: str) -> None: ...

soap_encoding = property(get_soap_encoding, set_soap_encoding)

Default Value

"http://schemas.xmlsoap.org/soap/encoding/"

Remarks

This is the value of the 'encodingStyle' attribute of the SOAP envelope.

soap_header Property

Contents of the optional SOAP header sent to the server.

Syntax

def get_soap_header() -> str: ...
def set_soap_header(value: str) -> None: ...

soap_header = property(get_soap_header, set_soap_header)

Default Value

""

Remarks

This property is used only while building SOAP requests.

soap_packet Property

Full contents of the SOAP packet.

Syntax

def get_soap_packet() -> str: ...
def set_soap_packet(value: str) -> None: ...

soap_packet = property(get_soap_packet, set_soap_packet)

Default Value

""

Remarks

The soap_packet property contains the contents of the SOAP packet created by the component before submitting a request, and the full, unmodified contents of the SOAP response as received from the server after the request.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

status_line Property

This property is the first line of the last server response.

Syntax

def get_status_line() -> str: ...

status_line = property(get_status_line, None)

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the status_line property.

The HTTP protocol specifies the structure of the status_line as follows: [HTTP version] [Result Code] [Description].

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

transferred_data Property

This property includes the contents of the last response from the server.

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the local_file is empty, the data are accumulated in transferred_data and also can be received in the on_transfer event. Otherwise, this property returns an empty string.

transferred_data_limit controls the maximum amount of data accumulated in transferred_data (by default there is no limit).

This property is read-only.

transferred_data_limit Property

This property specifies the the maximum amount of data to be transferred.

Syntax

def get_transferred_data_limit() -> int: ...
def set_transferred_data_limit(value: int) -> None: ...

transferred_data_limit = property(get_transferred_data_limit, set_transferred_data_limit)

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the transferred_data property.

transferred_headers Property

This property includes the full set of headers as received from the server.

Syntax

def get_transferred_headers() -> str: ...

transferred_headers = property(get_transferred_headers, None)

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The on_header event shows the individual headers as parsed by the class.

This property is read-only.

url Property

This property specifies the URL to fetch.

Syntax

def get_url() -> str: ...
def set_url(value: str) -> None: ...

url = property(get_url, set_url)

Default Value

""

Remarks

This property contains the URL of the document. This value is parsed, and the results are put in the url_scheme, url_server, url_port, and url_path properties.

user Property

This property includes a user name if authentication is to be used.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

value_format Property

Format of data returned or set.

Syntax

def get_value_format() -> int: ...
def set_value_format(value: int) -> None: ...

value_format = property(get_value_format, set_value_format)

Default Value

1

Remarks

The value_format property specifies the format of the data set or received into/from value properties such as x_text, return_value, and the params properties.

The following are the possible values:

attr_count Property

The number of records in the Attr arrays.

Syntax

def get_attr_count() -> int: ...

attr_count = property(get_attr_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• attr_name
• attr_namespace
• attr_prefix
• attr_value

The array indices start at 0 and end at attr_count - 1.

This property is read-only.

attr_name Property

The Name provides the local name (without prefix) of the attribute.

Syntax

def get_attr_name(attr_index: int) -> str: ...

Default Value

""

Remarks

The attr_name provides the local name (without prefix) of the attribute.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_namespace Property

Attribute namespace.

Syntax

def get_attr_namespace(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute namespace.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_prefix Property

Attribute prefix (if any).

Syntax

def get_attr_prefix(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_value Property

Attribute value.

Syntax

def get_attr_value(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute value.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

x_child_count Property

The number of records in the XChild arrays.

Syntax

def get_x_child_count() -> int: ...

x_child_count = property(get_x_child_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• x_child_name
• x_child_namespace
• x_child_prefix
• x_child_x_text

The array indices start at 0 and end at x_child_count - 1.

This property is read-only.

x_child_name Property

The Name property provides the local name (without prefix) of the element.

Syntax

def get_x_child_name(x_child_index: int) -> str: ...

Default Value

""

Remarks

The x_child_name property provides the local name (without prefix) of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_namespace Property

Namespace of the element.

Syntax

def get_x_child_namespace(x_child_index: int) -> str: ...

Default Value

""

Remarks

Namespace of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_prefix Property

Prefix of the element (if any).

Syntax

def get_x_child_prefix(x_child_index: int) -> str: ...

Default Value

""

Remarks

Prefix of the element (if any). If the element does not have a prefix, this property is empty.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_x_text Property

The inner text of the element.

Syntax

def get_x_child_x_text(x_child_index: int) -> str: ...

Default Value

""

Remarks

The inner text of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_element Property

The name of the element pointed to by XPath .

Syntax

def get_x_element() -> str: ...

x_element = property(get_x_element, None)

Default Value

""

Remarks

The corresponding prefix is provided by x_prefix.

This property is read-only.

x_namespace Property

The namespace of the element pointed to by XPath .

Syntax

def get_x_namespace() -> str: ...

x_namespace = property(get_x_namespace, None)

Default Value

""

Remarks

The corresponding namespace prefix is provided by x_prefix.

This property is read-only.

x_parent Property

The parent of the element pointed to by XPath .

Syntax

def get_x_parent() -> str: ...

x_parent = property(get_x_parent, None)

Default Value

""

Remarks

If xpath points to the top element, x_parent is an empty string.

This property is read-only.

xpath Property

A path into the SOAPPacket received by the server.

Syntax

def get_xpath() -> str: ...
def set_xpath(value: str) -> None: ...

xpath = property(get_xpath, set_xpath)

Default Value

""

Remarks

The syntax is a subset of the XPath language.

Use this property to look at details of the soap_packet received by the server.

x_prefix Property

The prefix of the element pointed to by XPath .

Syntax

def get_x_prefix() -> str: ...

x_prefix = property(get_x_prefix, None)

Default Value

""

Remarks

The corresponding element name is provided by x_element.

This property is read-only.

x_text Property

The text of the element pointed to by XPath .

Syntax

def get_x_text() -> str: ...

x_text = property(get_x_text, None)

Default Value

""

Remarks

The value_format property controls the format in which the value is returned.

This property is read-only.

add_cookie Method

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

def add_cookie(cookie_name: str, cookie_value: str) -> None: ...

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed.

add_namespace Method

Adds a namespace to the Namespaces properties.

Syntax

def add_namespace(prefix: str, namespace_uri: str) -> None: ...

Remarks

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

add_param Method

Adds a parameter-value pair.

Syntax

def add_param(param_name: str, param_value: str) -> None: ...

Remarks

Please refer to the parameter name and value provided in the params properties for more information on SOAP parameters and how they are managed.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest() Example (Send SOAP Request using Param Arrays) SOAPControl.Reset() SOAPControl.ParamCount = 2 SOAPControl.ParamName(0) = "paramname" SOAPControl.ParamValue(0) = "paramvalue" SOAPControl.ParamName(1) = "paramname2" SOAPControl.ParamValue(1) = "paramvalue2" SOAPControl.ParamAttrs(1) = "customattr=value" SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest()

attr Method

This method returns the value of the specified attribute.

Syntax

def attr(attr_name: str) -> str: ...

Remarks

If the attribute does not exist, an empty string is returned if ErrorOnEmptyAttr is set to False; otherwise, an exception is thrown.

Please refer to the x_attributes properties for more information.

build_packet Method

Build the request packet.

Syntax

def build_packet() -> None: ...

Remarks

The resulting packet is placed in soap_packet.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

eval_packet Method

Evaluate the packet in SOAPPacket .

Syntax

def eval_packet() -> None: ...

Remarks

Use this method to evaluate SOAP packets received through other means (i.e. not directly through the class).

has_xpath Method

Determines whether a specific element exists in the document.

Syntax

def has_xpath(xpath: str) -> bool: ...

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via xpath.

This method returns True if the xpath exists, False if not.

See xpath for details on the XPath syntax.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

Calling this method also resets all HTTP headers to their default values.

send_packet Method

Send the packet.

Syntax

def send_packet() -> None: ...

Remarks

This method may also be used to send a packet placed in soap_packet.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.BuildPacket() SOAPControl.SendPacket() SOAPControl.EvalPacket()

send_request Method

Send the request.

Syntax

def send_request() -> None: ...

Remarks

Calling this method is equivalent to calling build_packet, send_packet, and eval_packet in succession.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest()

try_xpath Method

Navigates to the specified XPath if it exists.

Syntax

def try_xpath(xpath: str) -> bool: ...

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists the xpath property will be updated and this method returns True.

If the XPath does not exist the xpath property is not updated and this method returns False.

value Method

Returns the value of a parameter.

Syntax

def value(param_name: str) -> str: ...

Remarks

The class will search through the params properties for the parameter identified by ParamName and will return the value associated with it provided in the properties.

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

class SOAPConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SOAP:
@property
def on_connected() -> Callable[[SOAPConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[SOAPConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

class SOAPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SOAP:
@property
def on_connection_status() -> Callable[[SOAPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[SOAPConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class SOAPDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SOAP:
@property
def on_disconnected() -> Callable[[SOAPDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SOAPDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer Event

Fired when a document finishes transferring.

Syntax

class SOAPEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class SOAP:
@property
def on_end_transfer() -> Callable[[SOAPEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[SOAPEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Information about errors during data delivery.

Syntax

class SOAPErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SOAP:
@property
def on_error() -> Callable[[SOAPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SOAPErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header Event

This event is fired every time a header line comes in.

Syntax

class SOAPHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class SOAP:
@property
def on_header() -> Callable[[SOAPHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[SOAPHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

This event fires once for each log message.

Syntax

class SOAPLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class SOAP:
@property
def on_log() -> Callable[[SOAPLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[SOAPLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_redirect Event

This event is fired when a redirection is received from the server.

Syntax

class SOAPRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SOAP:
@property
def on_redirect() -> Callable[[SOAPRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[SOAPRedirectEventParams], None]) -> None: ...

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie Event

This event is fired for every cookie set by the server.

Syntax

class SOAPSetCookieEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def expires() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def path() -> str: ...

  @property
  def secure() -> bool: ...

# In class SOAP:
@property
def on_set_cookie() -> Callable[[SOAPSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[SOAPSetCookieEventParams], None]) -> None: ...

Remarks

The on_set_cookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class SOAPSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SOAP:
@property
def on_ssl_server_authentication() -> Callable[[SOAPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SOAPSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class SOAPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class SOAP:
@property
def on_ssl_status() -> Callable[[SOAPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[SOAPSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

Fired when a document starts transferring (after the headers).

Syntax

class SOAPStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class SOAP:
@property
def on_start_transfer() -> Callable[[SOAPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[SOAPStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_status Event

This event is fired when the HTTP status line is received from the server.

Syntax

class SOAPStatusEventParams(object):
  @property
  def http_version() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SOAP:
@property
def on_status() -> Callable[[SOAPStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[SOAPStatusEventParams], None]) -> None: ...

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

on_transfer Event

Fired while the response transfers.

Syntax

class SOAPTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

# In class SOAP:
@property
def on_transfer() -> Callable[[SOAPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[SOAPTransferEventParams], None]) -> None: ...

Remarks

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the response (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

SOAP Config Settings

SOAP Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

SOAP Errors

SOAP Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

SSLClient Errors

SSL Errors

TCP/IP Errors

XML Errors