ShipRequest Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibxShipRequest

Remarks

The ShipRequest component 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 components. Requests created by this component can be used with FedEx, USPS, USPS using Endicia, and UPS.

To use this component 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 PostData to the body of the request. For USPS use AddParameter.

After specifying the request data to send to the server, call SubmitTo 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 SubmitTo returns, the XPath property may be set to a valid path within the XML returned, and XText 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:

• XAttributes
• XChildren
• XElement
• XErrorPath
• XNamespace
• XParent
• XPath
• XPrefix
• XSubTree
• XText

Following are examples of using the component to create a request for different services. Note that these examples show how to implement functionality existing in other components. To use any of the functionality demonstrated here, you may use the corresponding component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

BuildDOM Property (ShipRequest Component)

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

Syntax

__property bool BuildDOM = { read=FBuildDOM, write=FSetBuildDOM };

Default Value

true

Remarks

Set BuildDOM to True when you need to browse the current document through XPath.

Validate is automatically set to True when BuildDOM is set to True.

Data Type

Boolean

Connected Property (ShipRequest Component)

This shows whether the component is connected.

Syntax

__property bool Connected = { read=FConnected, write=FSetConnected };

Default Value

False

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

ContentType Property (ShipRequest Component)

This property includes the content type for posts and puts.

Syntax

__property String ContentType = { read=FContentType, write=FSetContentType };

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (ShipRequest Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (ShipRequest Component)

This property determines the type of firewall to connect through.

Syntax

__property TibxShipRequestFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TibxShipRequestFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (ShipRequest Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost 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 component raises an exception.

Data Type

String

FirewallPassword Property (ShipRequest Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (ShipRequest Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (ShipRequest Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

FollowRedirects Property (ShipRequest Component)

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

Syntax

__property TibxShipRequestFollowRedirects FollowRedirects = { read=FFollowRedirects, write=FSetFollowRedirects };

enum TibxShipRequestFollowRedirects {
  frNever=0,
  frAlways=1,
  frSameScheme=2
};

Default Value

frNever

Remarks

This property determines what happens when the server issues a redirect. Normally, the component 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 URLScheme is the same; otherwise, the component raises an exception.

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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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 component raises an exception instead.

Data Type

Integer

HTTPMethod Property (ShipRequest Component)

This property includes the HTTP method used for the request.

Syntax

__property String HTTPMethod = { read=FHTTPMethod, write=FSetHTTPMethod };

Default Value

""

Remarks

This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod 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 component. When providing a custom value, make the request by calling the Post method.

This property is not available at design time.

Data Type

String

Idle Property (ShipRequest Component)

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

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.

Data Type

Boolean

LocalFile Property (ShipRequest Component)

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

Syntax

__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };

Default Value

""

Remarks

This property is used when getting a document.

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

Data Type

String

LocalHost Property (ShipRequest Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost 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 component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NamespaceCount Property (ShipRequest Component)

The number of records in the Namespace arrays.

Syntax

__property int NamespaceCount = { read=FNamespaceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is read-only and not available at design time.

Data Type

Integer

NamespacePrefix Property (ShipRequest Component)

The Prefix for the Namespace .

Syntax

__property String NamespacePrefix[int NamespaceIndex] = { read=FNamespacePrefix };

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

NamespaceURI Property (ShipRequest Component)

Namespace URI associated with the corresponding Prefix .

Syntax

__property String NamespaceURI[int NamespaceIndex] = { read=FNamespaceURI };

Default Value

""

Remarks

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

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (ShipRequest Component)

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

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

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 ContentType 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 component beyond what is provided.

This property is not available at design time.

Data Type

String

ParameterCount Property (ShipRequest Component)

The number of records in the Parameter arrays.

Syntax

__property int ParameterCount = { read=FParameterCount, write=FSetParameterCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParameterName
• ParameterValue

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

This property is not available at design time.

Data Type

Integer

ParameterName Property (ShipRequest Component)

The Name of the Ship Parameter.

Syntax

__property String ParameterName[int ParamIndex] = { read=FParameterName };

Default Value

""

Remarks

The Name of the Ship Parameter.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParameterCount property.

This property is read-only and not available at design time.

Data Type

String

ParameterValue Property (ShipRequest Component)

The Value of the Ship Parameter.

Syntax

__property String ParameterValue[int ParamIndex] = { read=FParameterValue };

Default Value

""

Remarks

The Value of the Ship Parameter.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParameterCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderCount Property (ShipRequest Component)

The number of records in the ParsedHeader arrays.

Syntax

__property int ParsedHeaderCount = { read=FParsedHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (ShipRequest Component)

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

Syntax

__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };

Default Value

""

Remarks

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

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (ShipRequest Component)

This property contains the header contents.

Syntax

__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

PostData Property (ShipRequest Component)

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

Syntax

__property String PostData = { read=FPostData, write=FSetPostData };
__property DynamicArray<Byte> PostDataB = { read=FPostDataB, write=FSetPostDataB };

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

The most common example is posting of HTML form input data. In that case, the ContentType 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)

This property is not available at design time.

Data Type

Byte Array

ProxyAuthScheme Property (ShipRequest Component)

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

Syntax

__property TibxShipRequestProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibxShipRequestProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (ShipRequest Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (ShipRequest Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (ShipRequest Component)

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (ShipRequest Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (ShipRequest Component)

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

Syntax

__property TibxShipRequestProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibxShipRequestProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

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

Data Type

Integer

ProxyUser Property (ShipRequest Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEncoded Property (ShipRequest Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (ShipRequest Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (ShipRequest Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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).

Data Type

Byte Array

SSLCertStorePassword Property (ShipRequest Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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.

Data Type

String

SSLCertStoreType Property (ShipRequest Component)

This is the type of certificate store for this certificate.

Syntax

__property TibxShipRequestSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibxShipRequestSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (ShipRequest Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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.

Data Type

String

SSLProvider Property (ShipRequest Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibxShipRequestSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibxShipRequestSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (ShipRequest Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Byte Array

StatusLine Property (ShipRequest Component)

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

Syntax

__property String StatusLine = { read=FStatusLine };

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 component, the error string is the same as the StatusLine property.

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

This property is read-only and not available at design time.

Data Type

String

Timeout Property (ShipRequest Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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 component will wait for the operation to complete before returning control.

The component will use DoEvents 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 component raises an exception.

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.

Data Type

Integer

TransferredData Property (ShipRequest Component)

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

Syntax

__property String TransferredData = { read=FTransferredData };
__property DynamicArray<Byte> TransferredDataB = { read=FTransferredDataB };

Default Value

""

Remarks

This property contains the content of the last response from the server. If the LocalFile is empty, data are accumulated in TransferredData, and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in this property (by default, there is no limit).

This property is read-only and not available at design time.

Data Type

Byte Array

TransferredDataLimit Property (ShipRequest Component)

This property includes the maximum number of bytes of data to be transferred.

Syntax

__property __int64 TransferredDataLimit = { read=FTransferredDataLimit, write=FSetTransferredDataLimit };

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 component will accumulate and parse. If this value is set to a number n that is greater than zero, the component will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (ShipRequest Component)

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

Syntax

__property String TransferredHeaders = { read=FTransferredHeaders };

Default Value

""

Remarks

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

The Header event shows the individual headers as parsed by the component.

This property is read-only and not available at design time.

Data Type

String

Validate Property (ShipRequest Component)

This property controls whether documents are validated during parsing.

Syntax

__property bool Validate = { read=FValidate, write=FSetValidate };

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.

Data Type

Boolean

AttrCount Property (ShipRequest Component)

The number of records in the Attr arrays.

Syntax

__property int AttrCount = { read=FAttrCount, write=FSetAttrCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

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

This property is not available at design time.

Data Type

Integer

AttrName Property (ShipRequest Component)

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

Syntax

__property String AttrName[int AttrIndex] = { read=FAttrName };

Default Value

""

Remarks

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrNamespace Property (ShipRequest Component)

Attribute namespace.

Syntax

__property String AttrNamespace[int AttrIndex] = { read=FAttrNamespace };

Default Value

""

Remarks

Attribute namespace.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrPrefix Property (ShipRequest Component)

Attribute prefix (if any).

Syntax

__property String AttrPrefix[int AttrIndex] = { read=FAttrPrefix };

Default Value

""

Remarks

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrValue Property (ShipRequest Component)

Attribute value.

Syntax

__property String AttrValue[int AttrIndex] = { read=FAttrValue };

Default Value

""

Remarks

Attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

XChildCount Property (ShipRequest Component)

The number of records in the XChild arrays.

Syntax

__property int XChildCount = { read=FXChildCount, write=FSetXChildCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

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

This property is not available at design time.

Data Type

Integer

XChildName Property (ShipRequest Component)

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

Syntax

__property String XChildName[int XChildIndex] = { read=FXChildName };

Default Value

""

Remarks

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

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildNamespace Property (ShipRequest Component)

Namespace of the element.

Syntax

__property String XChildNamespace[int XChildIndex] = { read=FXChildNamespace };

Default Value

""

Remarks

Namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildPrefix Property (ShipRequest Component)

Prefix of the element (if any).

Syntax

__property String XChildPrefix[int XChildIndex] = { read=FXChildPrefix };

Default Value

""

Remarks

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

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildXText Property (ShipRequest Component)

The inner text of the element.

Syntax

__property String XChildXText[int XChildIndex] = { read=FXChildXText };

Default Value

""

Remarks

The inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XElement Property (ShipRequest Component)

The name of the current element.

Syntax

__property String XElement = { read=FXElement, write=FSetXElement };

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XErrorPath Property (ShipRequest Component)

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

Syntax

__property String XErrorPath = { read=FXErrorPath, write=FSetXErrorPath };

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.

Data Type

String

XNamespace Property (ShipRequest Component)

The namespace of the current element.

Syntax

__property String XNamespace = { read=FXNamespace, write=FSetXNamespace };

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (ShipRequest Component)

The parent of the current element.

Syntax

__property String XParent = { read=FXParent };

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (ShipRequest Component)

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

Syntax

__property String XPath = { read=FXPath, write=FSetXPath };

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:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath)

Data Type

String

XPrefix Property (ShipRequest Component)

The prefix of the current element.

Syntax

__property String XPrefix = { read=FXPrefix, write=FSetXPrefix };

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XSubTree Property (ShipRequest Component)

A snapshot of the current element in the document.

Syntax

__property String XSubTree = { read=FXSubTree };

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.

Data Type

String

XText Property (ShipRequest Component)

The text of the current element.

Syntax

__property String XText = { read=FXText, write=FSetXText };

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

AddParameter Method (ShipRequest Component)

Adds a parameter to the query string.

Syntax

void __fastcall AddParameter(String paramName, String paramValue);

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 ContentType 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 (ShipRequest Component)

Returns the value of the specified attribute.

Syntax

String __fastcall Attr(String AttrName);

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 XAttributes properties for more information.

Base64Decode Method (ShipRequest Component)

Decode base64 encoded string.

Syntax

DynamicArray<Byte> __fastcall Base64Decode(String encodedData);

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 (ShipRequest Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoEvents Method (ShipRequest Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

Get Method (ShipRequest Component)

This method fetches the document using the HTTP GET method.

Syntax

void __fastcall Get(String URL);

Remarks

This method fetches the document using the HTTP GET method. The document contents are delivered to the component and parsed. The XPath, XElement, and XText or the TransferredData property then can be used to traverse the data. The HTTP response headers are returned through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well.

Interrupt Method (ShipRequest Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

Reset Method (ShipRequest Component)

This method resets the component.

Syntax

void __fastcall Reset();

Remarks

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

SubmitTo Method (ShipRequest Component)

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

Syntax

void __fastcall SubmitTo(String URL);

Remarks

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

Following are examples of using the component to create a request for different services. Note that these examples show how to implement functionality existing in other components. To use any of the functionality demonstrated here, you may use the corresponding component 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);

Characters Event (ShipRequest Component)

Fired for plain text segments of the input stream.

Syntax

typedef struct {
  String Text;
} TibxShipRequestCharactersEventParams;
typedef void __fastcall (__closure *TibxShipRequestCharactersEvent)(System::TObject* Sender, TibxShipRequestCharactersEventParams *e);
__property TibxShipRequestCharactersEvent OnCharacters = { read=FOnCharacters, write=FOnCharacters };

Remarks

The 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 IgnorableWhitespace event.

Comment Event (ShipRequest Component)

Fired when a comment section is encountered.

Syntax

typedef struct {
  String Text;
} TibxShipRequestCommentEventParams;
typedef void __fastcall (__closure *TibxShipRequestCommentEvent)(System::TObject* Sender, TibxShipRequestCommentEventParams *e);
__property TibxShipRequestCommentEvent OnComment = { read=FOnComment, write=FOnComment };

Remarks

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

Connected Event (ShipRequest Component)

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

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TibxShipRequestConnectedEventParams;
typedef void __fastcall (__closure *TibxShipRequestConnectedEvent)(System::TObject* Sender, TibxShipRequestConnectedEventParams *e);
__property TibxShipRequestConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

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.

ConnectionStatus Event (ShipRequest Component)

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

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TibxShipRequestConnectionStatusEventParams;
typedef void __fastcall (__closure *TibxShipRequestConnectionStatusEvent)(System::TObject* Sender, TibxShipRequestConnectionStatusEventParams *e);
__property TibxShipRequestConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus 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:

Disconnected Event (ShipRequest Component)

This event is fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TibxShipRequestDisconnectedEventParams;
typedef void __fastcall (__closure *TibxShipRequestDisconnectedEvent)(System::TObject* Sender, TibxShipRequestDisconnectedEventParams *e);
__property TibxShipRequestDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

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.

EndElement Event (ShipRequest Component)

Fired when an end-element tag is encountered.

Syntax

typedef struct {
  String Namespace;
  String Element;
  String QName;
  bool IsEmpty;
} TibxShipRequestEndElementEventParams;
typedef void __fastcall (__closure *TibxShipRequestEndElementEvent)(System::TObject* Sender, TibxShipRequestEndElementEventParams *e);
__property TibxShipRequestEndElementEvent OnEndElement = { read=FOnEndElement, write=FOnEndElement };

Remarks

The EndElement 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.

EndPrefixMapping Event (ShipRequest Component)

Fired when leaving the scope of a namespace declaration.

Syntax

typedef struct {
  String Prefix;
} TibxShipRequestEndPrefixMappingEventParams;
typedef void __fastcall (__closure *TibxShipRequestEndPrefixMappingEvent)(System::TObject* Sender, TibxShipRequestEndPrefixMappingEventParams *e);
__property TibxShipRequestEndPrefixMappingEvent OnEndPrefixMapping = { read=FOnEndPrefixMapping, write=FOnEndPrefixMapping };

Remarks

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

Error Event (ShipRequest Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibxShipRequestErrorEventParams;
typedef void __fastcall (__closure *TibxShipRequestErrorEvent)(System::TObject* Sender, TibxShipRequestErrorEventParams *e);
__property TibxShipRequestErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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.

EvalEntity Event (ShipRequest Component)

Fired every time an entity needs to be evaluated.

Syntax

typedef struct {
  String Entity;
  String Value;
} TibxShipRequestEvalEntityEventParams;
typedef void __fastcall (__closure *TibxShipRequestEvalEntityEvent)(System::TObject* Sender, TibxShipRequestEvalEntityEventParams *e);
__property TibxShipRequestEvalEntityEvent OnEvalEntity = { read=FOnEvalEntity, write=FOnEvalEntity };

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.

Header Event (ShipRequest Component)

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

Syntax

typedef struct {
  String Field;
  String Value;
} TibxShipRequestHeaderEventParams;
typedef void __fastcall (__closure *TibxShipRequestHeaderEvent)(System::TObject* Sender, TibxShipRequestHeaderEventParams *e);
__property TibxShipRequestHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

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

IgnorableWhitespace Event (ShipRequest Component)

Fired when a section of ignorable whitespace is encountered.

Syntax

typedef struct {
  String Text;
} TibxShipRequestIgnorableWhitespaceEventParams;
typedef void __fastcall (__closure *TibxShipRequestIgnorableWhitespaceEvent)(System::TObject* Sender, TibxShipRequestIgnorableWhitespaceEventParams *e);
__property TibxShipRequestIgnorableWhitespaceEvent OnIgnorableWhitespace = { read=FOnIgnorableWhitespace, write=FOnIgnorableWhitespace };

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (ShipRequest Component)

Fired when a meta section is encountered.

Syntax

typedef struct {
  String Text;
} TibxShipRequestMetaEventParams;
typedef void __fastcall (__closure *TibxShipRequestMetaEvent)(System::TObject* Sender, TibxShipRequestMetaEventParams *e);
__property TibxShipRequestMetaEvent OnMeta = { read=FOnMeta, write=FOnMeta };

Remarks

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

PI Event (ShipRequest Component)

Fired when a processing instruction section is encountered.

Syntax

typedef struct {
  String Text;
} TibxShipRequestPIEventParams;
typedef void __fastcall (__closure *TibxShipRequestPIEvent)(System::TObject* Sender, TibxShipRequestPIEventParams *e);
__property TibxShipRequestPIEvent OnPI = { read=FOnPI, write=FOnPI };

Remarks

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

Redirect Event (ShipRequest Component)

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

Syntax

typedef struct {
  String Location;
  bool Accept;
} TibxShipRequestRedirectEventParams;
typedef void __fastcall (__closure *TibxShipRequestRedirectEvent)(System::TObject* Sender, TibxShipRequestRedirectEventParams *e);
__property TibxShipRequestRedirectEvent OnRedirect = { read=FOnRedirect, write=FOnRedirect };

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 component raises an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (ShipRequest Component)

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

Syntax

typedef struct {
  String Name;
  String Value;
  String Expires;
  String Domain;
  String Path;
  bool Secure;
} TibxShipRequestSetCookieEventParams;
typedef void __fastcall (__closure *TibxShipRequestSetCookieEvent)(System::TObject* Sender, TibxShipRequestSetCookieEventParams *e);
__property TibxShipRequestSetCookieEvent OnSetCookie = { read=FOnSetCookie, write=FOnSetCookie };

Remarks

The SetCookie 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 (URLServer) 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 (URLPath) 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.

SpecialSection Event (ShipRequest Component)

Fired when a special section is encountered.

Syntax

typedef struct {
  String SectionId;
  String Text;
} TibxShipRequestSpecialSectionEventParams;
typedef void __fastcall (__closure *TibxShipRequestSpecialSectionEvent)(System::TObject* Sender, TibxShipRequestSpecialSectionEventParams *e);
__property TibxShipRequestSpecialSectionEvent OnSpecialSection = { read=FOnSpecialSection, write=FOnSpecialSection };

Remarks

The SpecialSection 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").

SSLServerAuthentication Event (ShipRequest Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibxShipRequestSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibxShipRequestSSLServerAuthenticationEvent)(System::TObject* Sender, TibxShipRequestSSLServerAuthenticationEventParams *e);
__property TibxShipRequestSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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.

SSLStatus Event (ShipRequest Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibxShipRequestSSLStatusEventParams;
typedef void __fastcall (__closure *TibxShipRequestSSLStatusEvent)(System::TObject* Sender, TibxShipRequestSSLStatusEventParams *e);
__property TibxShipRequestSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

StartElement Event (ShipRequest Component)

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

Syntax

typedef struct {
  String Namespace;
  String Element;
  String QName;
  bool IsEmpty;
} TibxShipRequestStartElementEventParams;
typedef void __fastcall (__closure *TibxShipRequestStartElementEvent)(System::TObject* Sender, TibxShipRequestStartElementEventParams *e);
__property TibxShipRequestStartElementEvent OnStartElement = { read=FOnStartElement, write=FOnStartElement };

Remarks

The StartElement 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 AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

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

StartPrefixMapping Event (ShipRequest Component)

Fired when entering the scope of a namespace declaration.

Syntax

typedef struct {
  String Prefix;
  String URI;
} TibxShipRequestStartPrefixMappingEventParams;
typedef void __fastcall (__closure *TibxShipRequestStartPrefixMappingEvent)(System::TObject* Sender, TibxShipRequestStartPrefixMappingEventParams *e);
__property TibxShipRequestStartPrefixMappingEvent OnStartPrefixMapping = { read=FOnStartPrefixMapping, write=FOnStartPrefixMapping };

Remarks

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

Status Event (ShipRequest Component)

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

Syntax

typedef struct {
  String HTTPVersion;
  int StatusCode;
  String Description;
} TibxShipRequestStatusEventParams;
typedef void __fastcall (__closure *TibxShipRequestStatusEvent)(System::TObject* Sender, TibxShipRequestStatusEventParams *e);
__property TibxShipRequestStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

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").

Config Settings (ShipRequest Component)

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

Trappable Errors (ShipRequest Component)

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors