4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

ShipRequest Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DShipping.Shiprequest

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:

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>" +
	"<MeterNumber>000000000</MeterNumber>" +
	"<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

UPS

Component.PostData = @"<?xml version="1.0"?>" +
	@"<AccessRequest xml:lang="en-US">" +
	"<AccessLicenseNumber>YourAccessLicenseNumber</AccessLicenseNumber>" +
	"<UserId>userid</UserId>" +
	"<Password>password</Password>" +
	"</AccessRequest>" +
	@"<?xml version=\"1.0\"?>" +
	@"<VoidShipmentRequest xml:lang=\"en-US\">" +
	...
	
Component.SubmitTo("https://wwwcie.ups.com/ups.app/xml/Void");

Component.XPath = "/VoidShipmentResponse/Response/ResponseStatusCode";
if(Component.XText == "1")
	//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.

BuildDOMWhen True, an internal object model of the XML document is created.
ConnectedShows whether the component is connected.
ContentTypeContent type for posts and puts.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
HTTPMethodThe HTTP method used for the request.
IdleThe current status of the component.
LocalFileThe path to a local file for downloading. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NamespacesA collection of namespaces in the current stack.
OtherHeadersOther headers as determined by the user (optional).
ParametersParameters to be sent in the request.
ParsedHeadersCollection of headers returned from the last request.
PostDataThe data to post with the URL if the POST method is used.
ProxyA set of properties related to proxy access.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of bytes of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
ValidateWhen True, the parser checks that the document consists of well-formed XML.
XAttributesA collection of attributes of the current element.
XChildrenCollection of child elements of the current element.
XElementThe name of the current element.
XErrorPathAn XPath to check the server response for errors.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the response.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.

Method List


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

AddParameterAdds a parameter to the query string.
AttrReturns the value of the specified attribute.
Base64DecodeDecode base64 encoded string.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetFetches the document using the HTTP GET method.
InterruptInterrupt the current method.
ResetResets the component.
SubmitToPost current parameters to the URL specified by the 'URL' parameter.

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.

CharactersFired for plain text segments of the input stream.
CommentFired when a comment section is encountered.
ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndElementFired when an end-element tag is encountered.
EndPrefixMappingFired when leaving the scope of a namespace declaration.
ErrorInformation about errors during data delivery.
EvalEntityFired every time an entity needs to be evaluated.
HeaderFired every time a header line comes in.
IgnorableWhitespaceFired when a section of ignorable whitespace is encountered.
MetaFired when a meta section is encountered.
PIFired when a processing instruction section is encountered.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
SpecialSectionFired when a special section is encountered.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartElementFired when a begin-element tag is encountered in the document.
StartPrefixMappingFired when entering the scope of a namespace declaration.
StatusFired when the HTTP status line is received from the server.

Configuration Settings


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

CacheContentIf true, the original XML is saved in a buffer.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]