ShipRequest Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to create, send, and parse a custom request.

Syntax

class dshippingsdk.ShipRequest

Remarks

The ShipRequest class allows you to easily create a custom request for any operation. This is useful if you wish to support a service not currently implement by the existing classs. Requests created by this class can be used with FedEx, USPS, USPS using Endicia, and UPS.

To use this class first form the body of the request. The request body must then be passed to the component. This is done in one of two ways. For USPS with Endicia, FedEx, and UPS set post_data to the body of the request. For USPS use add_parameter.

After specifying the request data to send to the server, call submit_to and pass the URL of the server. This will send the request to the server and the response will be returned.

Once the call to submit_to returns, the xpath property may be set to a valid path within the XML returned, and x_text will hold the value of the element at the given path. A full list of xpath related properties that will help you parse the response is found below:

• x_attributes
• x_children
• x_element
• x_error_path
• x_namespace
• x_parent
• xpath
• x_prefix
• x_sub_tree
• x_text

Following are examples of using the class to create a request for different services. Note that these examples show how to implement functionality existing in other classs. To use any of the functionality demonstrated here, you may use the corresponding class instead.

FedEx Component.PostData = @"<?xml version="1.0" encoding="UTF-8" ?>" + @"<ProcessShipmentRequest xmlns="http://fedex.com/ws/ship/v9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">" + "<WebAuthenticationDetail>" + "<UserCredential>" + "<Key>MyKey</Key>" + "<Password>MyPassword</Password>" + "</UserCredential>" + "</WebAuthenticationDetail>" + "<ClientDetail>" + "<AccountNumber>000000000</AccountNumber>" + "<Localization>" + "<LanguageCode>en</LanguageCode>" + "<LocaleCode>en</LocaleCode>" + "</Localization>" + "</ClientDetail>" + ... Component.SubmitTo("https://gatewaybeta.fedex.com:443/xml"); Component.XPath = "/ProcessShipmentReply/Notifications/Severity"; if(Component.XText == "SUCCESS") //The request was successful

USPS With Endicia Component.PostData = "postageRateRequestXML=<PostageRateRequest>" + "<RequesterID>test</RequesterID>" + "<CertifiedIntermediary>" + "<AccountID>123456</AccountID>" + "<PassPhrase>test</PassPhrase>" + "</CertifiedIntermediary>" + "<MailClass>ExpressMailInternational</MailClass>" + "<WeightOz>1</WeightOz>" + "<MailpieceShape>FlatRateEnvelope</MailpieceShape>" + "<AutomationRate>FALSE</AutomationRate>" + "<Machinable>TRUE</Machinable>" + "<Services>" + "<InsuredMail>OFF</InsuredMail>" + "</Services>" + "<FromPostalCode>10022</FromPostalCode>" + "<ToCountry>Algeria</ToCountry>" + "</PostageRateRequest>"; Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://www.envmgr.com/LabelService/EwsLabelService.asmx/CalculatePostageRateXML"); Component.XPath = "/PostageRateResponse/Status"; if(Component.XText == "0") //The request was successful

USPS Component.AddParameter("XML",@"<CarrierPickupCancelRequest USERID="User" PASSWORD="Pass"><FirmName>ABC Corp.</FirmName>" + "<SuiteOrApt>Suite 777</SuiteOrApt>" + "<Address2>1390 Market Street</Address2>" + "<Urbanization></Urbanization>" + "<City>Houston</City>" + "<State>TX</State>" + "<ZIP5>77058</ZIP5>" + "<ZIP4>1234</ZIP4>" + "<ConfirmationNumber>WTC123456789</ConfirmationNumber>" + "</CarrierPickupCancelRequest>"); Component.AddParameter("API", "CarrierPickupCancel"); Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://secure.shippingapis.com/ShippingAPITest.dll"); Component.XPath = "/CarrierPickupCancelResponse/Status"; Console.WriteLine(Component.XText);

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.

build_dom Property

When True, an internal object model of the XML document is created.

Syntax

def get_build_dom() -> bool: ...
def set_build_dom(value: bool) -> None: ...

build_dom = property(get_build_dom, set_build_dom)

Default Value

TRUE

Remarks

Set build_dom to True when you need to browse the current document through xpath.

validate is automatically set to True when build_dom is set to True.

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

This property includes the content type for posts and puts.

Syntax

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

content_type = property(get_content_type, set_content_type)

Default Value

""

Remarks

If this property contains a nonempty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a post or put to the server.

The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded".

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.

http_method Property

This property includes the HTTP method used for the request.

Syntax

def get_http_method() -> str: ...
def set_http_method(value: str) -> None: ...

http_method = property(get_http_method, set_http_method)

Default Value

""

Remarks

This property contains the HTTP method used for the request. If an empty string is provided, the http_method is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the class. When providing a custom value, make the request by calling the post method.

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.

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.

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...

namespace_count = property(get_namespace_count, None)

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.

This property is read-only.

namespace_prefix Property

The Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...

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.

This property is read-only.

namespace_uri Property

Namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...

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.

This property is read-only.

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.

parameter_count Property

The number of records in the Parameter arrays.

Syntax

def get_parameter_count() -> int: ...
def set_parameter_count(value: int) -> None: ...

parameter_count = property(get_parameter_count, set_parameter_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parameter_name
• parameter_value

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

parameter_name Property

The Name of the Ship Parameter.

Syntax

def get_parameter_name(param_index: int) -> str: ...

Default Value

""

Remarks

The Name of the Ship Parameter.

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

This property is read-only.

parameter_value Property

The Value of the Ship Parameter.

Syntax

def get_parameter_value(param_index: int) -> str: ...

Default Value

""

Remarks

The Value of the Ship Parameter.

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

This property is read-only.

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.

post_data Property

This property includes the data to post with the URL if the POST method is used.

Syntax

def get_post_data() -> bytes: ...
def set_post_data(value: bytes) -> None: ...

post_data = property(get_post_data, set_post_data)

Default Value

""

Remarks

This property contains the data to post with the URL if the POST method is used. If this property contains a nonempty string, then if the HTTP POST method is used (post method), the contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP Content-Length header is also added to the request. Its value is the length of the string in post_data.

The most common example is posting of HTML form input data. In that case, the content_type property must be set to application/x-www-form-urlencoded.

Example. Performing a Post:

HTTPControl.ContentType = "application/x-www-form-urlencoded" HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US" HTTPControl.Post(myurl)

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 username 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.

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 content 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 content of the last response from the server. If the local_file is empty, 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 this property (by default, there is no limit).

This property is read-only.

transferred_data_limit Property

This property includes the maximum number of bytes 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 defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

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.

validate Property

This property controls whether documents are validated during parsing.

Syntax

def get_validate() -> bool: ...
def set_validate(value: bool) -> None: ...

validate = property(get_validate, set_validate)

Default Value

TRUE

Remarks

When True (default) the document will be validated during parsing. To disable validation set validate to False. Disabling validation may be useful in cases where data can still be parsed even if the document is not well-formed.

attr_count Property

The number of records in the Attr arrays.

Syntax

def get_attr_count() -> int: ...
def set_attr_count(value: int) -> None: ...

attr_count = property(get_attr_count, set_attr_count)

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.

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: ...
def set_x_child_count(value: int) -> None: ...

x_child_count = property(get_x_child_count, set_x_child_count)

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.

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 current element.

Syntax

def get_x_element() -> str: ...
def set_x_element(value: str) -> None: ...

x_element = property(get_x_element, set_x_element)

Default Value

""

Remarks

The current element is specified via the xpath property.

x_error_path Property

This property includes the XPath to check the server response for errors.

Syntax

def get_x_error_path() -> str: ...
def set_x_error_path(value: str) -> None: ...

x_error_path = property(get_x_error_path, set_x_error_path)

Default Value

""

Remarks

This property contains an XPath to check the server response for errors. If the XPath exists, an exception will be thrown containing the value of the element at the path.

x_namespace Property

The namespace of the current element.

Syntax

def get_x_namespace() -> str: ...
def set_x_namespace(value: str) -> None: ...

x_namespace = property(get_x_namespace, set_x_namespace)

Default Value

""

Remarks

The current element is specified via the xpath property.

x_parent Property

The parent of the current element.

Syntax

def get_x_parent() -> str: ...

x_parent = property(get_x_parent, None)

Default Value

""

Remarks

The current element is specified via the xpath property.

This property is read-only.

xpath Property

Provides a way to point to a specific element in the response.

Syntax

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

xpath = property(get_xpath, set_xpath)

Default Value

""

Remarks

xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to True prior to parsing the document for the xpath functionality to be available.

Example (Setting XPath)

x_prefix Property

The prefix of the current element.

Syntax

def get_x_prefix() -> str: ...
def set_x_prefix(value: str) -> None: ...

x_prefix = property(get_x_prefix, set_x_prefix)

Default Value

""

Remarks

The current element is specified via the xpath property.

x_sub_tree Property

A snapshot of the current element in the document.

Syntax

def get_x_sub_tree() -> str: ...

x_sub_tree = property(get_x_sub_tree, None)

Default Value

""

Remarks

The current element is specified via the xpath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

x_text Property

The text of the current element.

Syntax

def get_x_text() -> str: ...
def set_x_text(value: str) -> None: ...

x_text = property(get_x_text, set_x_text)

Default Value

""

Remarks

The current element is specified via the xpath property.

add_parameter Method

Adds a parameter to the query string.

Syntax

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

Remarks

This method is used to add a parameter name and value to the query string to be sent to the server. Note that any parameters added with this method will be URL encoded automatically.

If content_type is set to "application/x-www-form-urlencoded", any parameters added with this method will be sent to the server as form data in the body of the request, instead of as query string parameters.

attr 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.

base64_decode Method

Decode base64 encoded string.

Syntax

def base64_decode(encoded_data: str) -> bytes: ...

Remarks

This method decodes the provided base64 encoded string. Some operations may result in base64 encoded data (such as a label image) being returned by the server. Use this method to decode such data. The decoded data is returned as a byte array.

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.

get Method

This method fetches the document using the HTTP GET method.

Syntax

def get(url: str) -> None: ...

Remarks

This method fetches the document using the HTTP GET method. The document contents are delivered to the component and parsed. The xpath, x_element, and x_text or the transferred_data property then can be used to traverse the data. The HTTP response headers are returned through the on_header event. If local_file is not empty, the data (not the headers) are written there as well.

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

This method resets the class.

Syntax

def reset() -> None: ...

Remarks

This method resets all HTTP headers to default values and resets the XML parser.

submit_to Method

Post current parameters to the URL specified by the 'URL' parameter.

Syntax

def submit_to(url: str) -> None: ...

Remarks

A post request is sent to the url with the specified parameters and values. The response is given via the transferred_data property.

Following are examples of using the class to create a request for different services. Note that these examples show how to implement functionality existing in other classs. To use any of the functionality demonstrated here, you may use the corresponding class instead.

FedEx Component.PostData = @"<?xml version="1.0" encoding="UTF-8" ?>" + @"<ProcessShipmentRequest xmlns="http://fedex.com/ws/ship/v9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">" + "<WebAuthenticationDetail>" + "<UserCredential>" + "<Key>MyKey</Key>" + "<Password>MyPassword</Password>" + "</UserCredential>" + "</WebAuthenticationDetail>" + "<ClientDetail>" + "<AccountNumber>000000000</AccountNumber>" + "<Localization>" + "<LanguageCode>en</LanguageCode>" + "<LocaleCode>en</LocaleCode>" + "</Localization>" + "</ClientDetail>" + ... Component.SubmitTo("https://gatewaybeta.fedex.com:443/xml"); Component.XPath = "/ProcessShipmentReply/Notifications/Severity"; if(Component.XText == "SUCCESS") //The request was successful

USPS With Endicia Component.PostData = "postageRateRequestXML=<PostageRateRequest>" + "<RequesterID>test</RequesterID>" + "<CertifiedIntermediary>" + "<AccountID>123456</AccountID>" + "<PassPhrase>test</PassPhrase>" + "</CertifiedIntermediary>" + "<MailClass>ExpressMailInternational</MailClass>" + "<WeightOz>1</WeightOz>" + "<MailpieceShape>FlatRateEnvelope</MailpieceShape>" + "<AutomationRate>FALSE</AutomationRate>" + "<Machinable>TRUE</Machinable>" + "<Services>" + "<InsuredMail>OFF</InsuredMail>" + "</Services>" + "<FromPostalCode>10022</FromPostalCode>" + "<ToCountry>Algeria</ToCountry>" + "</PostageRateRequest>"; Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://www.envmgr.com/LabelService/EwsLabelService.asmx/CalculatePostageRateXML"); Component.XPath = "/PostageRateResponse/Status"; if(Component.XText == "0") //The request was successful

USPS Component.AddParameter("XML",@"<CarrierPickupCancelRequest USERID="User" PASSWORD="Pass"><FirmName>ABC Corp.</FirmName>" + "<SuiteOrApt>Suite 777</SuiteOrApt>" + "<Address2>1390 Market Street</Address2>" + "<Urbanization></Urbanization>" + "<City>Houston</City>" + "<State>TX</State>" + "<ZIP5>77058</ZIP5>" + "<ZIP4>1234</ZIP4>" + "<ConfirmationNumber>WTC123456789</ConfirmationNumber>" + "</CarrierPickupCancelRequest>"); Component.AddParameter("API", "CarrierPickupCancel"); Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://secure.shippingapis.com/ShippingAPITest.dll"); Component.XPath = "/CarrierPickupCancelResponse/Status"; Console.WriteLine(Component.XText);

on_characters Event

Fired for plain text segments of the input stream.

Syntax

class ShipRequestCharactersEventParams(object):
  @property
  def text() -> str: ...

# In class ShipRequest:
@property
def on_characters() -> Callable[[ShipRequestCharactersEventParams], None]: ...
@on_characters.setter
def on_characters(event_hook: Callable[[ShipRequestCharactersEventParams], None]) -> None: ...

Remarks

The on_characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the on_ignorable_whitespace event.

on_comment Event

Fired when a comment section is encountered.

Syntax

class ShipRequestCommentEventParams(object):
  @property
  def text() -> str: ...

# In class ShipRequest:
@property
def on_comment() -> Callable[[ShipRequestCommentEventParams], None]: ...
@on_comment.setter
def on_comment(event_hook: Callable[[ShipRequestCommentEventParams], None]) -> None: ...

Remarks

The on_comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

on_connected Event

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

Syntax

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

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

# In class ShipRequest:
@property
def on_connected() -> Callable[[ShipRequestConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[ShipRequestConnectedEventParams], 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 ShipRequestConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

# In class ShipRequest:
@property
def on_connection_status() -> Callable[[ShipRequestConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[ShipRequestConnectionStatusEventParams], 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 ShipRequestDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class ShipRequest:
@property
def on_disconnected() -> Callable[[ShipRequestDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[ShipRequestDisconnectedEventParams], 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_element Event

Fired when an end-element tag is encountered.

Syntax

class ShipRequestEndElementEventParams(object):
  @property
  def namespace() -> str: ...

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

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

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

# In class ShipRequest:
@property
def on_end_element() -> Callable[[ShipRequestEndElementEventParams], None]: ...
@on_end_element.setter
def on_end_element(event_hook: Callable[[ShipRequestEndElementEventParams], None]) -> None: ...

Remarks

The on_end_element event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

on_end_prefix_mapping Event

Fired when leaving the scope of a namespace declaration.

Syntax

class ShipRequestEndPrefixMappingEventParams(object):
  @property
  def prefix() -> str: ...

# In class ShipRequest:
@property
def on_end_prefix_mapping() -> Callable[[ShipRequestEndPrefixMappingEventParams], None]: ...
@on_end_prefix_mapping.setter
def on_end_prefix_mapping(event_hook: Callable[[ShipRequestEndPrefixMappingEventParams], None]) -> None: ...

Remarks

The on_start_prefix_mapping event is fired when entering the scope of a namespace declaration.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

# In class ShipRequest:
@property
def on_error() -> Callable[[ShipRequestErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[ShipRequestErrorEventParams], 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_eval_entity Event

Fired every time an entity needs to be evaluated.

Syntax

class ShipRequestEvalEntityEventParams(object):
  @property
  def entity() -> str: ...

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

# In class ShipRequest:
@property
def on_eval_entity() -> Callable[[ShipRequestEvalEntityEventParams], None]: ...
@on_eval_entity.setter
def on_eval_entity(event_hook: Callable[[ShipRequestEvalEntityEventParams], None]) -> None: ...

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

on_header Event

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

Syntax

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

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

# In class ShipRequest:
@property
def on_header() -> Callable[[ShipRequestHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[ShipRequestHeaderEventParams], 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_ignorable_whitespace Event

Fired when a section of ignorable whitespace is encountered.

Syntax

class ShipRequestIgnorableWhitespaceEventParams(object):
  @property
  def text() -> str: ...

# In class ShipRequest:
@property
def on_ignorable_whitespace() -> Callable[[ShipRequestIgnorableWhitespaceEventParams], None]: ...
@on_ignorable_whitespace.setter
def on_ignorable_whitespace(event_hook: Callable[[ShipRequestIgnorableWhitespaceEventParams], None]) -> None: ...

Remarks

The ignorable whitespace section is provided by the Text parameter.

on_meta Event

Fired when a meta section is encountered.

Syntax

class ShipRequestMetaEventParams(object):
  @property
  def text() -> str: ...

# In class ShipRequest:
@property
def on_meta() -> Callable[[ShipRequestMetaEventParams], None]: ...
@on_meta.setter
def on_meta(event_hook: Callable[[ShipRequestMetaEventParams], None]) -> None: ...

Remarks

The on_meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

on_pi Event

Fired when a processing instruction section is encountered.

Syntax

class ShipRequestPIEventParams(object):
  @property
  def text() -> str: ...

# In class ShipRequest:
@property
def on_pi() -> Callable[[ShipRequestPIEventParams], None]: ...
@on_pi.setter
def on_pi(event_hook: Callable[[ShipRequestPIEventParams], None]) -> None: ...

Remarks

The on_pi event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

on_redirect Event

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

Syntax

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

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

# In class ShipRequest:
@property
def on_redirect() -> Callable[[ShipRequestRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[ShipRequestRedirectEventParams], 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 ShipRequestSetCookieEventParams(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 ShipRequest:
@property
def on_set_cookie() -> Callable[[ShipRequestSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[ShipRequestSetCookieEventParams], 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_special_section Event

Fired when a special section is encountered.

Syntax

class ShipRequestSpecialSectionEventParams(object):
  @property
  def section_id() -> str: ...

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

# In class ShipRequest:
@property
def on_special_section() -> Callable[[ShipRequestSpecialSectionEventParams], None]: ...
@on_special_section.setter
def on_special_section(event_hook: Callable[[ShipRequestSpecialSectionEventParams], None]) -> None: ...

Remarks

The on_special_section event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, while the SectionId parameter provides the section identifier (e.g. "CDATA").

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class ShipRequestSSLServerAuthenticationEventParams(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 ShipRequest:
@property
def on_ssl_server_authentication() -> Callable[[ShipRequestSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[ShipRequestSSLServerAuthenticationEventParams], 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

Fired when secure connection progress messages are available.

Syntax

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

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

Remarks

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

on_start_element Event

Fired when a begin-element tag is encountered in the document.

Syntax

class ShipRequestStartElementEventParams(object):
  @property
  def namespace() -> str: ...

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

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

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

# In class ShipRequest:
@property
def on_start_element() -> Callable[[ShipRequestStartElementEventParams], None]: ...
@on_start_element.setter
def on_start_element(event_hook: Callable[[ShipRequestStartElementEventParams], None]) -> None: ...

Remarks

The on_start_element event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the attr_name, attr_namespace, attr_prefix, and attr_value properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

on_start_prefix_mapping Event

Fired when entering the scope of a namespace declaration.

Syntax

class ShipRequestStartPrefixMappingEventParams(object):
  @property
  def prefix() -> str: ...

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

# In class ShipRequest:
@property
def on_start_prefix_mapping() -> Callable[[ShipRequestStartPrefixMappingEventParams], None]: ...
@on_start_prefix_mapping.setter
def on_start_prefix_mapping(event_hook: Callable[[ShipRequestStartPrefixMappingEventParams], None]) -> None: ...

Remarks

The on_end_prefix_mapping event is fired when leaving the scope of a namespace declaration.

on_status Event

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

Syntax

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

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

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

# In class ShipRequest:
@property
def on_status() -> Callable[[ShipRequestStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[ShipRequestStatusEventParams], 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").

ShipRequest Config Settings

ShipRequest 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

Base Config Settings

ShipRequest 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.

TCPClient Errors

SSL Errors

TCP/IP Errors