ShipRequest Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

inship.shiprequest()

Remarks

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

To use this class first form the body of the request. The request body must then be passed to the component. This is done in one of two ways. For USPS with Endicia, FedEx, and UPS set 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>" +
	"<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);