ShipRequest Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DShippingSDK_ShipRequest

Procedural Interface

 dshippingsdk_shiprequest_open();
 dshippingsdk_shiprequest_close($res);
 dshippingsdk_shiprequest_register_callback($res, $id, $function);
 dshippingsdk_shiprequest_get_last_error($res);
 dshippingsdk_shiprequest_get_last_error_code($res);
 dshippingsdk_shiprequest_set($res, $id, $index, $value);
 dshippingsdk_shiprequest_get($res, $id, $index);
 dshippingsdk_shiprequest_do_addparameter($res, $paramname, $paramvalue);
 dshippingsdk_shiprequest_do_attr($res, $attrname);
 dshippingsdk_shiprequest_do_base64decode($res, $encodeddata);
 dshippingsdk_shiprequest_do_config($res, $configurationstring);
 dshippingsdk_shiprequest_do_doevents($res);
 dshippingsdk_shiprequest_do_get($res, $url);
 dshippingsdk_shiprequest_do_interrupt($res);
 dshippingsdk_shiprequest_do_reset($res);
 dshippingsdk_shiprequest_do_submitto($res, $url);

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

BuildDOM Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getBuildDOM();


public function setBuildDOM($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 1 );


dshippingsdk_shiprequest_set($res, 1, $value );

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 (DShippingSDK_ShipRequest Class)

This shows whether the class is connected.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 2 );


dshippingsdk_shiprequest_set($res, 2, $value );

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.

This property is not available at design time.

Data Type

Boolean

ContentType Property (DShippingSDK_ShipRequest Class)

This property includes the content type for posts and puts.

Object Oriented Interface

public function getContentType();


public function setContentType($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 3 );


dshippingsdk_shiprequest_set($res, 3, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 4 );


dshippingsdk_shiprequest_set($res, 4, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (DShippingSDK_ShipRequest Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 5 );


dshippingsdk_shiprequest_set($res, 5, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 6 );


dshippingsdk_shiprequest_set($res, 6, $value );

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 class fails with an error.

Data Type

String

FirewallPassword Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 7 );


dshippingsdk_shiprequest_set($res, 7, $value );

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 class fails with an error.

Data Type

String

FirewallPort Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 8 );


dshippingsdk_shiprequest_set($res, 8, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 9 );


dshippingsdk_shiprequest_set($res, 9, $value );

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 class fails with an error.

Data Type

String

FollowRedirects Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getFollowRedirects();


public function setFollowRedirects($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 10 );


dshippingsdk_shiprequest_set($res, 10, $value );

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 URLScheme 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 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 class fails with an error instead.

Data Type

Integer

HTTPMethod Property (DShippingSDK_ShipRequest Class)

This property includes the HTTP method used for the request.

Object Oriented Interface

public function getHTTPMethod();


public function setHTTPMethod($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 11 );


dshippingsdk_shiprequest_set($res, 11, $value );

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 class. 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 (DShippingSDK_ShipRequest Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

dshippingsdk_shiprequest_get($res, 12 );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 13 );


dshippingsdk_shiprequest_set($res, 13, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 14 );


dshippingsdk_shiprequest_set($res, 14, $value );

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

If the class 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 (DShippingSDK_ShipRequest Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();

Procedural Interface

dshippingsdk_shiprequest_get($res, 15 );

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 (DShippingSDK_ShipRequest Class)

The Prefix for the Namespace .

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 16 , $namespaceindex);

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 (DShippingSDK_ShipRequest Class)

Namespace URI associated with the corresponding Prefix .

Object Oriented Interface

public function getNamespaceURI($namespaceindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 17 , $namespaceindex);

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 18 );


dshippingsdk_shiprequest_set($res, 18, $value );

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

This property is not available at design time.

Data Type

String

ParameterCount Property (DShippingSDK_ShipRequest Class)

The number of records in the Parameter arrays.

Object Oriented Interface

public function getParameterCount();


public function setParameterCount($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 19 );


dshippingsdk_shiprequest_set($res, 19, $value );

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 (DShippingSDK_ShipRequest Class)

The Name of the Ship Parameter.

Object Oriented Interface

public function getParameterName($paramindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 20 , $paramindex);

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 (DShippingSDK_ShipRequest Class)

The Value of the Ship Parameter.

Object Oriented Interface

public function getParameterValue($paramindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 21 , $paramindex);

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 (DShippingSDK_ShipRequest Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

dshippingsdk_shiprequest_get($res, 22 );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 23 , $parsedheaderindex);

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 (DShippingSDK_ShipRequest Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 24 , $parsedheaderindex);

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getPostData();


public function setPostData($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 25 );


dshippingsdk_shiprequest_set($res, 25, $value );

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

Binary String

ProxyAuthScheme Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 26 );


dshippingsdk_shiprequest_set($res, 26, $value );

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 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 class. Look at the configuration file for the class 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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 27 );


dshippingsdk_shiprequest_set($res, 27, $value );

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.

Data Type

Boolean

ProxyPassword Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 28 );


dshippingsdk_shiprequest_set($res, 28, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 29 );


dshippingsdk_shiprequest_set($res, 29, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 30 );


dshippingsdk_shiprequest_set($res, 30, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 31 );


dshippingsdk_shiprequest_set($res, 31, $value );

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:

Data Type

Integer

ProxyUser Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 32 );


dshippingsdk_shiprequest_set($res, 32, $value );

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 (DShippingSDK_ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 34 );


dshippingsdk_shiprequest_set($res, 34, $value );

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

Binary String

SSLCertEncoded Property (DShippingSDK_ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 62 );


dshippingsdk_shiprequest_set($res, 62, $value );

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

Binary String

SSLCertStore Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 78 );


dshippingsdk_shiprequest_set($res, 78, $value );

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

Binary String

SSLCertStorePassword Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 79 );


dshippingsdk_shiprequest_set($res, 79, $value );

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 (DShippingSDK_ShipRequest Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 80 );


dshippingsdk_shiprequest_set($res, 80, $value );

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:

Data Type

Integer

SSLCertSubject Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 81 );


dshippingsdk_shiprequest_set($res, 81, $value );

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 (DShippingSDK_ShipRequest Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 89 );


dshippingsdk_shiprequest_set($res, 89, $value );

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.

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_shiprequest_get($res, 91 );

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

Binary String

StatusLine Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getStatusLine();

Procedural Interface

dshippingsdk_shiprequest_get($res, 118 );

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 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 (DShippingSDK_ShipRequest Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 119 );


dshippingsdk_shiprequest_set($res, 119, $value );

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

Data Type

Integer

TransferredData Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getTransferredData();

Procedural Interface

dshippingsdk_shiprequest_get($res, 120 );

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

Binary String

TransferredDataLimit Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getTransferredDataLimit();


public function setTransferredDataLimit($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 121 );


dshippingsdk_shiprequest_set($res, 121, $value );

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.

Data Type

Long64

TransferredHeaders Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getTransferredHeaders();

Procedural Interface

dshippingsdk_shiprequest_get($res, 122 );

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

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

Data Type

String

Validate Property (DShippingSDK_ShipRequest Class)

This property controls whether documents are validated during parsing.

Object Oriented Interface

public function getValidate();


public function setValidate($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 123 );


dshippingsdk_shiprequest_set($res, 123, $value );

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 (DShippingSDK_ShipRequest Class)

The number of records in the Attr arrays.

Object Oriented Interface

public function getAttrCount();


public function setAttrCount($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 124 );


dshippingsdk_shiprequest_set($res, 124, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getAttrName($attrindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 125 , $attrindex);

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 (DShippingSDK_ShipRequest Class)

Attribute namespace.

Object Oriented Interface

public function getAttrNamespace($attrindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 126 , $attrindex);

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 (DShippingSDK_ShipRequest Class)

Attribute prefix (if any).

Object Oriented Interface

public function getAttrPrefix($attrindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 127 , $attrindex);

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 (DShippingSDK_ShipRequest Class)

Attribute value.

Object Oriented Interface

public function getAttrValue($attrindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 128 , $attrindex);

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 (DShippingSDK_ShipRequest Class)

The number of records in the XChild arrays.

Object Oriented Interface

public function getXChildCount();


public function setXChildCount($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 129 );


dshippingsdk_shiprequest_set($res, 129, $value );

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getXChildName($xchildindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 130 , $xchildindex);

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 (DShippingSDK_ShipRequest Class)

Namespace of the element.

Object Oriented Interface

public function getXChildNamespace($xchildindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 131 , $xchildindex);

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 (DShippingSDK_ShipRequest Class)

Prefix of the element (if any).

Object Oriented Interface

public function getXChildPrefix($xchildindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 132 , $xchildindex);

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 (DShippingSDK_ShipRequest Class)

The inner text of the element.

Object Oriented Interface

public function getXChildXText($xchildindex);

Procedural Interface

dshippingsdk_shiprequest_get($res, 133 , $xchildindex);

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 (DShippingSDK_ShipRequest Class)

The name of the current element.

Object Oriented Interface

public function getXElement();


public function setXElement($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 134 );


dshippingsdk_shiprequest_set($res, 134, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XErrorPath Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getXErrorPath();


public function setXErrorPath($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 135 );


dshippingsdk_shiprequest_set($res, 135, $value );

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 (DShippingSDK_ShipRequest Class)

The namespace of the current element.

Object Oriented Interface

public function getXNamespace();


public function setXNamespace($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 136 );


dshippingsdk_shiprequest_set($res, 136, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (DShippingSDK_ShipRequest Class)

The parent of the current element.

Object Oriented Interface

public function getXParent();

Procedural Interface

dshippingsdk_shiprequest_get($res, 137 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function getXPath();


public function setXPath($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 138 );


dshippingsdk_shiprequest_set($res, 138, $value );

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 (DShippingSDK_ShipRequest Class)

The prefix of the current element.

Object Oriented Interface

public function getXPrefix();


public function setXPrefix($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 139 );


dshippingsdk_shiprequest_set($res, 139, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XSubTree Property (DShippingSDK_ShipRequest Class)

A snapshot of the current element in the document.

Object Oriented Interface

public function getXSubTree();

Procedural Interface

dshippingsdk_shiprequest_get($res, 140 );

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 (DShippingSDK_ShipRequest Class)

The text of the current element.

Object Oriented Interface

public function getXText();


public function setXText($value);

Procedural Interface

dshippingsdk_shiprequest_get($res, 141 );


dshippingsdk_shiprequest_set($res, 141, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

AddParameter Method (DShippingSDK_ShipRequest Class)

Adds a parameter to the query string.

Object Oriented Interface

public function doAddParameter($paramname, $paramvalue);

Procedural Interface

dshippingsdk_shiprequest_do_addparameter($res, $paramname, $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 (DShippingSDK_ShipRequest Class)

Returns the value of the specified attribute.

Object Oriented Interface

public function doAttr($attrname);

Procedural Interface

dshippingsdk_shiprequest_do_attr($res, $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 (DShippingSDK_ShipRequest Class)

Decode base64 encoded string.

Object Oriented Interface

public function doBase64Decode($encodeddata);

Procedural Interface

dshippingsdk_shiprequest_do_base64decode($res, $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 (DShippingSDK_ShipRequest Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_shiprequest_do_config($res, $configurationstring);

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.

DoEvents Method (DShippingSDK_ShipRequest Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

dshippingsdk_shiprequest_do_doevents($res);

Remarks

When DoEvents 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 (DShippingSDK_ShipRequest Class)

This method fetches the document using the HTTP GET method.

Object Oriented Interface

public function doGet($url);

Procedural Interface

dshippingsdk_shiprequest_do_get($res, $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 (DShippingSDK_ShipRequest Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dshippingsdk_shiprequest_do_interrupt($res);

Remarks

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

Reset Method (DShippingSDK_ShipRequest Class)

This method resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_shiprequest_do_reset($res);

Remarks

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

SubmitTo Method (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function doSubmitTo($url);

Procedural Interface

dshippingsdk_shiprequest_do_submitto($res, $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 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);

Characters Event (DShippingSDK_ShipRequest Class)

Fired for plain text segments of the input stream.

Object Oriented Interface

public function fireCharacters($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 1, array($this, 'fireCharacters'));

Parameter List

 'text'

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 (DShippingSDK_ShipRequest Class)

Fired when a comment section is encountered.

Object Oriented Interface

public function fireComment($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 2, array($this, 'fireComment'));

Parameter List

 'text'

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 3, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 4, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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 (DShippingSDK_ShipRequest Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 5, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

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 (DShippingSDK_ShipRequest Class)

Fired when an end-element tag is encountered.

Object Oriented Interface

public function fireEndElement($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 6, array($this, 'fireEndElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

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 (DShippingSDK_ShipRequest Class)

Fired when leaving the scope of a namespace declaration.

Object Oriented Interface

public function fireEndPrefixMapping($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 7, array($this, 'fireEndPrefixMapping'));

Parameter List

 'prefix'

Remarks

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

Error Event (DShippingSDK_ShipRequest Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 8, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

EvalEntity Event (DShippingSDK_ShipRequest Class)

Fired every time an entity needs to be evaluated.

Object Oriented Interface

public function fireEvalEntity($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 9, array($this, 'fireEvalEntity'));

Parameter List

 'entity'
 'value'

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 10, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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 (DShippingSDK_ShipRequest Class)

Fired when a section of ignorable whitespace is encountered.

Object Oriented Interface

public function fireIgnorableWhitespace($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 11, array($this, 'fireIgnorableWhitespace'));

Parameter List

 'text'

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (DShippingSDK_ShipRequest Class)

Fired when a meta section is encountered.

Object Oriented Interface

public function fireMeta($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 12, array($this, 'fireMeta'));

Parameter List

 'text'

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 (DShippingSDK_ShipRequest Class)

Fired when a processing instruction section is encountered.

Object Oriented Interface

public function firePI($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 13, array($this, 'firePI'));

Parameter List

 'text'

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 (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 14, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

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 FollowRedirects property.

SetCookie Event (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 15, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

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 (DShippingSDK_ShipRequest Class)

Fired when a special section is encountered.

Object Oriented Interface

public function fireSpecialSection($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 16, array($this, 'fireSpecialSection'));

Parameter List

 'sectionid'
 'text'

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 (DShippingSDK_ShipRequest Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 17, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (DShippingSDK_ShipRequest Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 18, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartElement Event (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireStartElement($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 19, array($this, 'fireStartElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

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 (DShippingSDK_ShipRequest Class)

Fired when entering the scope of a namespace declaration.

Object Oriented Interface

public function fireStartPrefixMapping($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 20, array($this, 'fireStartPrefixMapping'));

Parameter List

 'prefix'
 'uri'

Remarks

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

Status Event (DShippingSDK_ShipRequest Class)

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dshippingsdk_shiprequest_register_callback($res, 21, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

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

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

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