USPSShip Class
Properties Methods Events Config Settings Errors
Allows you to generate a USPS shipping label for any of USPS domestic services complete with addresses and barcode, or manage pickups. To get a label with USPS, postage must be paid. To get a label with postage you must use ppNone , ppEndicia , or ppStamps as your PostageProvider . Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS (or Electronic Verification System) Label API allows high-volume package mailers and package consolidators to document and pay postage, including special service fees, using electronic manifest files.
Syntax
dshippingsdk.Uspsship
Remarks
Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any other special services you want to associate the shipment (such as Return Shipment, etc.).
This is useful if you have your own Postnet barcode generating software.
In addition, the class can submit a request for your carrier to pick up packages from your current location. You can schedule multiple pickups and edit or cancel previously submitted pickups, and even electronically determine if carrier pickup is available at your current address.
The following methods are available for scheduling carrier pickups:
PickupAvailability | Checks the availability of a Carrier Pickup service for the given address. |
SchedulePickup | Schedules a Carrier Pickup. |
PickupInquiry | Returns all the data submitted in your original SchedulePickup request. |
ChangePickup | Changes your original scheduled pickup with updated information (number of packages, change the date, etc). |
CancelPickup | Cancels a scheduled Carrier Pickup request. |
Postage Provider Notes
ppNoneWhen using USPS as the PostageProvider (i.e. ppNone) you will need to...
- Set PostageProvider to ppNone (default).
- Set UserId to the UserId provided by USPS.
- Set Password to the password provided by USPS.
- Set Server to either the test or production server.
When using Endicia as the PostageProvider there are different instructions for Production and Testing.
Production
Endicia will provide you with a production account number and password. To use your account with the components...
- Set PostageProvider to ppEndicia.
- Set AccountNumber to your production account number (provided by Endicia).
- Set Password to your production password (provided by Endicia).
The components come with a built in sandbox account for your use. To use that account with the components...
- Set PostageProvider to ppEndicia.
- Set EndiciaTestMode to either 1 or 2.
ppStamps
When using Stamps.com as the PostageProvider you will need to...
- Set PostageProvider to ppStamps.
- Set UserId to the sandbox or production user provided by Stamps.com.
- Set AccountNumber to the sandbox or production account number provided by Stamps.com.
- Set Password to the sandbox or production password provided by Stamps.com.
- Set Server to either the test or production server.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AddressServiceRequest | Indicates if an address service request is made. |
BarcodeNumber | Barcode number associated with label's barcode. |
Contents | Type of the contents in the package. |
CountExpress | The number of Express Mail packages to be picked up. |
CountInternational | The number of International Mail packages to be picked up. |
CountOther | The number of packages to be picked up for a service type other than Priority/Express/International Mail. |
CountPriority | The number of Priority Mail packages to be picked up. |
CustomerId | User-assigned number for internal use. |
CustomerReceipt | Image of the Customer Online Record. |
CustomerReceiptFile | Filename for CustomerReceipt (optional). |
DeliveryOption | Indicates the type of delivery option. |
ExtraServices | Contains the collection of extra services offered by USPS on shipment level. |
Firewall | A set of properties related to firewall access. |
InsuranceCost | Insurance fee for the package being shipped. |
LabelImageType | Type of label image. |
LabelOption | Indicates type of label the USPS Server will return. |
Machinable | Indicates if shipment is machinable or not. |
MailingLocation | Postal Office Zip Code where the item will be mailed (if different from ZipCode ). |
Notify | Collection of e-mail notifications to be sent. |
PackageLocation | The location of pickup. |
Packages | A collection of packages contained in the shipment. |
PermitIssuingPOAddress | Address of the Post Office that issued the permit. |
PermitNumber | Permit number to print Postage Due labels. |
PostageDueAddress | Address of the Postage Due Unit (on the delivery address). |
PostageProvider | The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used. |
PostalZone | Indicates the number of postal rate zones between the origin and destination zip codes. |
PriceOption | Indicates pricing that should be returned (i.e. Commercial Base). |
Proxy | This property includes a set of properties related to proxy access. |
RecipientAddress | Identifies the recipient's address. |
RecipientContact | Identifies the recipient's contact info. |
RMABarcode | Indicates whether to print the RMANumber as a barcode on the label. |
RMANumber | Return Materials Authorization number. |
SenderAddress | Identifies the sender's address. |
SenderContact | Identifies the sender's contact info. |
SeparateReceipt | Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages. |
ServiceType | Identifies the USPS service type (applicable to US domestic shipments) to use in a ship request. |
ShipDate | Date package will be mailed. |
ShipmentSpecialServices | Contains the collection of special services offered by USPS on shipment level. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
StandardizeAddress | Checks the delivery address against the USPS Address Matching System. |
Timeout | A timeout for the class. |
TotalWeight | The estimated weight for the package to be picked up. |
TransactionId | The transaction Id. |
USPSAccount | Login information for USPS. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CancelPackage | Cancels a single package by deleting it from the eVS shipping log. |
CancelPickup | Cancels a scheduled Carrier Pickup request. |
ChangePickup | Changes requested data in your original Pickup Schedule request and schedules a new pickup. |
Config | Sets or retrieves a configuration setting. |
GetPackageLabel | Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. |
PickupAvailability | Checks the availability of a Carrier Pickup service for the given address. |
PickupInquiry | Retrieves the data submitted in your original SchedulePickup request. |
Reset | Resets the internal state of the class and all properties to their default values. |
SchedulePickup | Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup. |
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.
Error | Information about errors during data delivery. |
Notification | Notification returned by the server upon successful request (if applicable). |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ActionCode | Use to specify the Action Code. |
AddOnAggregate[i] | Indicates the AddOn raw XML. |
AddOnAmount[i] | Indicates the AddOn amount. |
AddOnCount | Total number of AddOns. |
AddOnType[i] | Indicates the AddOn type. |
AddOnTypeDescription[i] | Indicates the AddOn description. |
AddOnTypes | The AddOn type to be requested. |
AllowBadAddress | Indicates whether the destination and origin addresses should be verified. |
CarrierRelease | Indicates if the CARRIER LEAVE IF NO RESPONSE is to be printed on the eVS Domestic Labels. |
CarrierRoute | The carrier route. |
Certify | Certify/Test mode for label classes. |
ContentDescription | Content Description of a package. |
CRID | Customer Registration ID. |
CustomerId2 | User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API. |
EMCAAccount | For future use. |
EMCAPassword | For future use. |
EndiciaCODAS3816 | Indicates whether the 2-part Form AS3816 will be used. |
EndiciaCODEndorsement | Optional endorsement string on the form. |
EndiciaCODPMExpressReturn | Indicates whether the COD is to be returned by Express Mail. |
EndiciaCODReturnAddress1 | Return Addressee's Address Line 1. |
EndiciaCODReturnCity | Return Addressee's City. |
EndiciaCODReturnName | Return Addressee's name. |
EndiciaCODReturnPostalCode | Return Addressee's Postal Code. |
EndiciaCODReturnState | Return Addressee's State. |
EndiciaCODUSPSCA | USPS Corporate Account Number. |
EndiciaCostCenter | Cost-center code for accounting purposes. |
EndiciaHazMatDescription | HazMat Description. |
EndiciaHazMatPhone | HazMat phone number. |
EndiciaInsuranceType | The Insurance type when using Endicia. |
EndiciaInsuredMail | Used to request Endicia mailpiece insurance. |
EndiciaLabelType | The Endicia label type to be used. |
EndiciaMailClass | Specifies the mail class used with the Consolidator Service request. |
EndiciaPrintConsolidatorLabel | Used to request Consolidator Services. |
EndiciaPrintScanBasedLabel | Used to request Pay-on-Use Returns. |
EndiciaReplyPostage | Used to request postage paid return labels. |
EndiciaTestMode | Controls whether requests are test requests or live requests. |
EndiciaValidateAddress | Defines if the address should be validated or not. |
EntryFacility | Postal facility where mail is entered. |
EscapeEndiciaXML | Whether to escape XML special characters when using Endicia. |
eSOFAllowed | Electronic Signature On File (eSOF) Allowed. Valid for USPS eVS Domestic Labels only. |
HasXPath | Determines whether a specific element exists in the document. |
HoldForManifest | Holds manifest record for inclusion in SCAN request. |
ImageParameters | For future use. |
IncludeEndiciaCODForm | Indicates whether the COD labels should be returned in the response. |
IncludePostage | Used to determine if the postage will be printed on the label. |
IntegratorTxId | Stamps.com transaction integrator Id. |
LabelImageResolution | The resolution of the label. |
LabelImageRotation | The rotation of the label. |
LabelSize | The size of the label. |
LogisticsManagerMID | Logistics Manager Mailer ID. |
Memo | Customer defined data to be printed on a Stamps shipping label. |
MerchandiseReturnNumber | The number assigned to the return package. |
MID | Mailer ID. |
NineDigitRoutingZip | Nine Digit Routing Zip. Valid for USPS eVS Domestic Labels only. |
OptOutOfSPE | Opt out of Shipping Partner Event file creation. |
Overwrite | Determines whether label files will be overwritten. |
PackageLabelUrl | Stamps.com label Url. |
PackageNumber | The package number to be used in the case of multiple packages. |
POZipCode | ZIP Code of Post Office. |
PrintCustomerRefNo | Print Customer Reference Number (CustomerId). Valid for USPS eVS Domestic Labels only. |
PrintCustomerRefNo2 | Print Customer Reference Number 2 (CustomerId2). Valid for USPS eVS Domestic Labels only. |
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
ReceiptOption | Indicates the Label and Receipt layout options. |
RegisteredMailValue | The value of registered mail sent in the request. |
RequestId | The ID used to identify a particular request/response pair when tracking Endicia packages. |
RubberStamp1 | Customer defined data to be printed on label. |
RubberStamp2 | Customer defined data to be printed on label. |
RubberStamp3 | Customer defined data to be printed on label. |
SCANFormImage | Image of the PS Form 3152 or PS Form 5630. |
SCANFormImageFile | The location where the SCAN Form Image will be written. |
SCANFormNumber | Returns the Form Number from the last succesful call to USPSCreateManifest. |
SCANFormType | Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest. |
SCANPackageBarcodes | A list of Package Barcodes to include in the SCAN Request (create a manifest for). |
SenderPhoneExt | Sender's phone number extension. |
ShipInfo | Ship Info. Valid for USPS eVS Domestic Labels only. |
ShipTime | Time package will be mailed. |
SortType | Sort level for applicable mail classes. |
SpecialInstructions | Special instructions for pickup location. |
StampsAPIVersion | Controls the API version used for requests. |
StampsCreateManifest | Sends a request to create a manifest for the specified shipments. |
StampsCreateManifestId | Returns the ManifestId from the last succesful call to StampsCreateManifest. |
StampsCreateManifestIdentifier | A list of identifiers to create a manifest for. |
StampsCreateManifestIdentifierType | Used to indicate the type of identifier used. |
StampsTestMode | Controls whether requests are test requests or live requests. |
StampsTxId | Stamps.com transaction identifier. |
TotalPackages | The total number of packages to be used in the case of multiple packages. |
UseStandardPost | Used to retrieve Standard Post shipping labels. |
UseStealth | Used to determine if the postage price is printed on the label. |
USPSCreateManifest | Sends a SCAN request to create a manifest for the specified shipments. |
VendorCode | Vendor Code to identify the developer of the shipping system. |
VendorProductVersionNumber | Vendor Product Version Number. |
XAttrCount | The number of records in the XAttr arrays. |
XAttrName[i] | The name of the indexed attribute. |
XAttrValue[i] | The value of the indexed attribute. |
XChildCount | The number of records in the XChild arrays. |
XChildElement[i] | The name of the indexed child element. |
XChildText[i] | The text of the indexed child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Used to set the XPath within the response from the server. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
AddressServiceRequest Property (USPSShip Class)
Indicates if an address service request is made.
Syntax
public boolean isAddressServiceRequest(); public void setAddressServiceRequest(boolean addressServiceRequest);
Default Value
False
Remarks
The value of this property is optional. False is assumed if no value is entered.
By setting this property to True, you can request the USPS to alert you when a customer changes their address. This feature is especially useful to ensure correct billing. The words "Address Service Requested" will appear on the shipping label immediately below the return address.
By using this option, you will receive the following service with Priority Mail:
- For 12 months after an address change, the mail piece is forwarded at no charge. However, a separate notice of the new address is returned to you and an address correction fee is charged.
- For 13-18 months after an address change, the mail piece is returned with the new address attached at no charge.
- After 18 months, or if undeliverable, the mail piece is returned with the reason for nondelivery attached at no charge.
BarcodeNumber Property (USPSShip Class)
Barcode number associated with label's barcode.
Syntax
public String getBarcodeNumber();
Default Value
""
Remarks
The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).
This property is read-only.
Contents Property (USPSShip Class)
Type of the contents in the package.
Syntax
public int getContents(); public void setContents(int contents); Enumerated values: public final static int ctSample = 0; public final static int ctGift = 1; public final static int ctDocuments = 2; public final static int ctReturn = 3; public final static int ctOther = 4; public final static int ctMerchandise = 5; public final static int ctHumanitarianDonation = 6; public final static int ctDangerousGoods = 7; public final static int ctCrematedRemains = 8; public final static int ctNonNegotiableDocument = 9; public final static int ctPharmaceuticals = 10; public final static int ctMedicalSupplies = 11; public final static int ctHAZMAT = 12; public final static int ctLives = 13; public final static int ctPerishable = 14;
Default Value
0
Remarks
You can set this property when generating labels to indicate the content type in the package.
Possible values are as follows:
Value | Endicia & Stamps International | USPS (eVS International) | USPS (eVS Domestic) | |
ctSample (0) | X | X | ||
ctGift (1) | X | X | ||
ctDocuments (2) | X | X | ||
ctReturn (3) | X | X | ||
ctOther (4) | X | X | ||
ctMerchandise (5) | X | X | ||
ctHumanitarianDonation (6) | X | X | ||
ctDangerousGoods (7) | X | X | ||
ctCrematedRemains (8) | X | X | ||
ctNonNegotiableDocument (9) | X | |||
ctPharmaceuticals (10) | X | X | ||
ctMedicalSupplies (11) | X | X | ||
ctHAZMAT (12) | X | |||
ctLives (13) | X | |||
ctPerishable (14) | X |
Note that if Contents is set to ctLives, you must also set the ContentDescription configuration setting. For example:
class.Contents = ctLives;
class.Config("ContentDescription=0");
CountExpress Property (USPSShip Class)
The number of Express Mail packages to be picked up.
Syntax
public int getCountExpress(); public void setCountExpress(int countExpress);
Default Value
0
Remarks
When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountInternational, and CountOther properties to indicate such.
The maximum count is 999 packages.
CountInternational Property (USPSShip Class)
The number of International Mail packages to be picked up.
Syntax
public int getCountInternational(); public void setCountInternational(int countInternational);
Default Value
0
Remarks
When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, and CountOther properties to indicate such.
The maximum count is 999 packages.
CountOther Property (USPSShip Class)
The number of packages to be picked up for a service type other than Priority/Express/International Mail.
Syntax
public int getCountOther(); public void setCountOther(int countOther);
Default Value
0
Remarks
When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, CountInternational properties to indicate such.
The maximum count is 999 packages.
CountPriority Property (USPSShip Class)
The number of Priority Mail packages to be picked up.
Syntax
public int getCountPriority(); public void setCountPriority(int countPriority);
Default Value
0
Remarks
When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountExpress, CountInternational, and CountOther properties to indicate such.
The maximum count is 999 packages.
CustomerId Property (USPSShip Class)
User-assigned number for internal use.
Syntax
public String getCustomerId(); public void setCustomerId(String customerId);
Default Value
""
Remarks
You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.
Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.
For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.
CustomerReceipt Property (USPSShip Class)
Image of the Customer Online Record.
Syntax
public byte[] getCustomerReceipt();
Default Value
""
Remarks
If you want to have the Customer Online Label Record and ShippingLabel in separate image files, you can accomplish this by setting the ReceiptOption property to 1 (meaning "SEPARATE PAGE"). This image can be generated in PDF or TIF format. The image type is determined by setting LabelImageType property prior to submitting the request.
The Customer Receipt must be presented when filing an indemnity claim and/or for a postage refund.
This property is read-only.
CustomerReceiptFile Property (USPSShip Class)
Filename for CustomerReceipt (optional).
Syntax
public String getCustomerReceiptFile(); public void setCustomerReceiptFile(String customerReceiptFile);
Default Value
""
Remarks
When this property is set to a valid filename, the contents of the CustomerReceipt property are written into the file.
The file will be saved in the format defined by the value of LabelImageType property, and the filename should include the appropriate extension.
DeliveryOption Property (USPSShip Class)
Indicates the type of delivery option.
Syntax
public int getDeliveryOption(); public void setDeliveryOption(int deliveryOption); Enumerated values: public final static int edoNormal = 0; public final static int edoNoWeekend = 1; public final static int edoNoHoliday = 2; public final static int edoNoWeekend_OR_Holiday = 3; public final static int edoNoSaturday = 4; public final static int edoNoSunday = 5; public final static int edoSunday = 6; public final static int edoHoliday = 7; public final static int edoNoSunday_OR_Holiday = 8; public final static int edoScheduledEndofDay = 9; public final static int edoScheduledEndofDay_NoSunday_OR_Holiday = 10; public final static int edoScheduledEndofDay_NoWeekend_OR_Holiday = 11;
Default Value
1
Remarks
Note that this property is valid when ServiceType is stUSPSPriorityExpress (85).
The default value for this property is edoNormal.
Possible values are as follows:
Value | Description |
edoNormal (1) | Normal Delivery (default) |
edoNoWeekend (2) | No Weekend Delivery |
edoNoHoliday (3) | No Holiday Delivery |
edoNoWeekend_OR_Holiday (4) | No Weekend or Holiday Delivery |
edoNoSaturday (5) | No Saturday Delivery |
edoNoSunday (6) | No Sunday Delivery |
edoSunday (7) | Sunday Delivery |
edoHoliday (8) | Holiday Delivery |
edoNoSunday_OR_Holiday (9) | No Sunday or Holiday Delivery |
edoScheduledEndofDay (10) | Scheduled End of Day |
edoScheduledEndofDay_NoSunday_OR_Holiday (11) | Scheduled End of Day No Sunday or Holiday Delivery |
edoScheduledEndofDay_NoWeekend_OR_Holiday (12) | Scheduled End of Day No Weekend or Holiday Delivery |
ExtraServices Property (USPSShip Class)
Contains the collection of extra services offered by USPS on shipment level.
Syntax
public long getExtraServices(); public void setExtraServices(long extraServices);
Default Value
0
Remarks
To request any of the extra services offered by USPS, you must set the ExtraServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x00000001L | Certified Mail |
0x00000002L | Certified Mail Restricted Delivery |
0x00000004L | Certified Mail Adult Signature Required |
0x00000008L | Certified Mail Adult Signature Restricted Delivery |
0x00000010L | Insurance |
0x00000020L | Insurance PME |
0x00000040L | Insurance PM |
0x00000080L | Insurance Restricted Delivery |
0x00000100L | Insurance Restricted Delivery PME |
0x00000200L | Insurance Restricted Delivery PM |
0x00000400L | Return Receipt |
0x00000800L | Return Receipt Electronic |
0x00001000L | Return Receipt Express Mail |
0x00002000L | Adult Signature |
0x00004000L | Adult Signature Restricted Delivery |
0x00008000L | Signature Confirmation Electronic |
0x00010000L | Signature Confirmation Electronic Restricted Delivery |
0x00020000L | Scan Retention |
0x00040000L | Scan and Signature Retention |
0x00080000L | Special Handling Fragile |
0x00100000L | 10:30 AM Delivery PME |
0x00200000L | USPS Tracking Electronic |
0x00400000L | Electronic USPS Delivery Confirmation International |
Firewall Property (USPSShip Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.
InsuranceCost Property (USPSShip Class)
Insurance fee for the package being shipped.
Syntax
public String getInsuranceCost();
Default Value
""
Remarks
This is a computed cost of insurance based on the value specified in InsuredValue.
The value of this property is filled after a call to the GetPackageLabel method only when the Return Shipment flag has been set in the ShipmentSpecialServices property.
This property is read-only.
LabelImageType Property (USPSShip Class)
Type of label image.
Syntax
public int getLabelImageType(); public void setLabelImageType(int labelImageType); Enumerated values: public final static int sitNone = 0; public final static int sitTIF = 1; public final static int sitJPG = 2; public final static int sitPDF = 3; public final static int sitGIF = 4; public final static int sitEPL = 5; public final static int sitPNG = 6; public final static int sitZPL = 7; public final static int sitPDFVector = 8; public final static int sitPDFVectorWithFonts = 9; public final static int sitAZPL = 10;
Default Value
0
Remarks
The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:
sitNone (0) | Enter sitNone if a label is not desired. (Only the TrackingNumber will be returned). |
sitTIF (1) | Tagged Image File format (bitmap). |
sitJPG (2) | Joint Photographic expert Group format. |
sitPDF (3) | Adobe Acrobat's Portable Document format. |
sitGIF (4) | CompuServe's Graphics Interchange format. |
sitEPL (5) | EPL2 format. |
sitPNG (6) | PNG image. |
sitZPL (7) | ZPLII format. |
sitPDFVector (8) | PDFVector format. |
sitPDFVectorWithFonts (9) | PDFVectorWithFonts format. |
sitAZPL (10) | AZPL format. |
Valid values for USPS (eVSLabels):
- sitTIF (1)
- sitPDF (3)
Valid values for Endicia:
- sitJPG (2)
- sitPDF (3)
- sitGIF (4)
- sitEPL (5)
- sitPNG (6)
- sitZPL (7)
- sitPDFVector (8)
- sitPDFVectorWithFonts (9)
Valid values for Stamps.com:
- sitJPG (2)
- sitPDF (3)
- sitGIF (4)
- sitEPL (5)
- sitPNG (6)
- sitZPL (7)
- sitAZPL (10)
LabelOption Property (USPSShip Class)
Indicates type of label the USPS Server will return.
Syntax
public String getLabelOption(); public void setLabelOption(String labelOption);
Default Value
""
Remarks
For Delivery and Signature confirmation, the USPS Server may return either an entire label with the 'To' and 'From' address and the confirmation barcode, or a label with only the barcode and tracking number may be returned. Label options 1 and 2 are available for both Delivery Confirmation labels and Signature Confirmation labels. Detailed descriptions of these label options are included below.
Option | Description |
1 | A graphic image is returned that will include a barcode, a delivery or signature confirmation number (TrackingNumber) with return name and address and delivery name and address; |
2 | A graphic image is returned that will include a barcode and a delivery confirmation number (TrackingNumber) without the return and delivery name and address. This option is convenient for shippers who already have mailing labels and just want the Confirmation barcode. |
Machinable Property (USPSShip Class)
Indicates if shipment is machinable or not.
Syntax
public int getMachinable(); public void setMachinable(int machinable); Enumerated values: public final static int moTrue = 0; public final static int moFalse = 1; public final static int moIrregular = 2;
Default Value
0
Remarks
The default value for this property is moTrue (0).
Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).
Possible values are as follows:
Value | Description |
moTrue (0) | True (default) |
moFalse (1) | False |
moIrregular (2) | Irregular |
MailingLocation Property (USPSShip Class)
Postal Office Zip Code where the item will be mailed (if different from ZipCode ).
Syntax
public String getMailingLocation(); public void setMailingLocation(String mailingLocation);
Default Value
""
Remarks
The value of this property is optional.
If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (ZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.
This way, you convey this difference to the USPS Server.
Notify Property (USPSShip Class)
Collection of e-mail notifications to be sent.
Syntax
public NotifyDetailList getNotify(); public void setNotify(NotifyDetailList notify);
Remarks
The Notify is optional to be provided in a ship request. This should be set only if the shipper wants to send e-mail notifications.
For each idx = 0 to NotifyCount - 1 (where NotifyCount<=2), this must be set to an instance of the NotifyDetail type, which will contain specific information about the notification to be e-mailed. See the NotifyDetail type for more information.
Each notification has a: RecipientType, Email, and Name tied to it. The only valid recipient types for USPS are rtRecipient and rtShipper.
For instance, if only one notification is requested to be sent:
class.Notify[0].Email = "test@test.com";
class.Notify[0].RecipientType = rtShipper;
class.Notify[0].Name = "My Name";
This property is not available at design time.
PackageLocation Property (USPSShip Class)
The location of pickup.
Syntax
public int getPackageLocation(); public void setPackageLocation(int packageLocation); Enumerated values: public final static int plNotSet = 0; public final static int plFrontDoor = 1; public final static int plBackDoor = 2; public final static int plSideDoor = 3; public final static int plKnockOnDoor = 4; public final static int plMailRoom = 5; public final static int plOffice = 6; public final static int plReception = 7; public final static int plInMailbox = 8; public final static int plOther = 9;
Default Value
0
Remarks
This property is required when the following methods are called:
- SchedulePickup (required)
- ChangePickup (optional)
- CancelPickup (optional)
- PickupInquiry method call.
The allowed values to be selected are: Front Door, Back Door, Side Door, Knock on Door/Ring Bell, Mail Room, Office, Reception, In/At Mailbox, Other
Note: When plOther is selected, the SpecialInstructions property is required to be entered.
Packages Property (USPSShip Class)
A collection of packages contained in the shipment.
Syntax
public PackageDetailList getPackages(); public void setPackages(PackageDetailList packages);
Remarks
At least one package must be specified.
This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.
For USPS, the PackagingType, Size, and Weight fields are required. Length, Width, Height, and Girth are all conditionally required, and more information may be found in the individual field definitions.
Note: USPS only supports one package per shipment.
This property is not available at design time.
PermitIssuingPOAddress Property (USPSShip Class)
Address of the Post Office that issued the permit.
Syntax
public AddressDetail getPermitIssuingPOAddress(); public void setPermitIssuingPOAddress(AddressDetail permitIssuingPOAddress);
Remarks
Sending postage due packages requires a permit with a US Post Office. This property should contain the address of the post office that issued the permit.
The only necessary fields to be set for this type are the City, State, and ZipCode.
This must be set to an instance of the AddressDetail type. See the AddressDetail type for more information.
PermitNumber Property (USPSShip Class)
Permit number to print Postage Due labels.
Syntax
public String getPermitNumber(); public void setPermitNumber(String permitNumber);
Default Value
""
Remarks
Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.
PostageDueAddress Property (USPSShip Class)
Address of the Postage Due Unit (on the delivery address).
Syntax
public AddressDetail getPostageDueAddress(); public void setPostageDueAddress(AddressDetail postageDueAddress);
Remarks
This is the address of the Postage Due Unit, which the shipping label will be addressed to. The package will be delivered to the post office that issued your permit, and postage due will be charged. This property is required when the Return Shipment flag has been set in the ShipmentSpecialServices property and appears on the Return Label.
The Address1 field MUST contain the PO Box number of Postage Due Unit.
This must be set to an instance of the AddressDetail type. See the AddressDetail type for more information.
PostageProvider Property (USPSShip Class)
The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
Syntax
public int getPostageProvider(); public void setPostageProvider(int postageProvider); Enumerated values: public final static int ppNone = 0; public final static int ppEndicia = 1; public final static int ppStamps = 2;
Default Value
0
Remarks
When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.
When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.
For Production
- Set AccountNumber
- Set Password
For Testing
- Set EndiciaTestMode
When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.
- Set UserId
- Set AccountNumber
- Set Password
- Set Server
PostalZone Property (USPSShip Class)
Indicates the number of postal rate zones between the origin and destination zip codes.
Syntax
public String getPostalZone();
Default Value
""
Remarks
The Postal Zone (which might be "Local" or "0 through 8") identifies the appropriate distance code assigned to each origination and destination Zip Code pairing for every Zip Code in the nation. These zones are used for Priority Mail packages over 5 lbs.
The value of this property is filled by the response from the USPS server.
This property is read-only.
PriceOption Property (USPSShip Class)
Indicates pricing that should be returned (i.e. Commercial Base).
Syntax
public int getPriceOption(); public void setPriceOption(int priceOption); Enumerated values: public final static int poRetail = 0; public final static int poCommercialPlus = 1; public final static int poCommercialBase = 2;
Default Value
2
Remarks
The default value for this property is poCommercialBase (2).
Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).
Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).
Possible values are as follows:
Value | Description |
poRetail (0) | Retail |
poCommercialPlus (1) | Commercial Plus |
poCommercialBase (2) | Commercial Base (default) |
Proxy Property (USPSShip Class)
This property includes a set of properties related to proxy access.
Syntax
public Proxy getProxy(); public void setProxy(Proxy proxy);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
RecipientAddress Property (USPSShip Class)
Identifies the recipient's address.
Syntax
public AddressDetail getRecipientAddress(); public void setRecipientAddress(AddressDetail recipientAddress);
Remarks
The RecipientAddress is required to be provided in a ship request.
This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.
RecipientContact Property (USPSShip Class)
Identifies the recipient's contact info.
Syntax
public ContactDetail getRecipientContact(); public void setRecipientContact(ContactDetail recipientContact);
Remarks
The RecipientContact is required to be provided in a ship request.
The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.
RMABarcode Property (USPSShip Class)
Indicates whether to print the RMANumber as a barcode on the label.
Syntax
public boolean isRMABarcode(); public void setRMABarcode(boolean RMABarcode);
Default Value
False
Remarks
The RMA number entered by the user through the RMANumber property can also appear as a US128C barcode on the label. If you wish to see the number displayed as a barcode on the label, set this property to True. Enter False if no barcode is desired.
RMANumber Property (USPSShip Class)
Return Materials Authorization number.
Syntax
public String getRMANumber(); public void setRMANumber(String RMANumber);
Default Value
""
Remarks
The value of this optional property may be any combination of alphanumerical characters, up to a maximum length of 30. If entered, this number will appear on the Return Label.
Assigning an RMA number to each package at the time an agreement is made with a customer (to have merchandise returned), enables retailers to provide a closed-loop correlation between receipt of returned packages and records of the order, typically kept in an order-processing database.
SenderAddress Property (USPSShip Class)
Identifies the sender's address.
Syntax
public AddressDetail getSenderAddress(); public void setSenderAddress(AddressDetail senderAddress);
Remarks
The SenderAddress is required to be provided in a ship request when the GetPackageLabel method is called.
This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.
SenderContact Property (USPSShip Class)
Identifies the sender's contact info.
Syntax
public ContactDetail getSenderContact(); public void setSenderContact(ContactDetail senderContact);
Remarks
The SenderContact is required to be provided in a ship request, when the GetPackageLabel method is called.
This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.
SeparateReceipt Property (USPSShip Class)
Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.
Syntax
public boolean isSeparateReceipt(); public void setSeparateReceipt(boolean separateReceipt);
Default Value
False
Remarks
The value of this property is optional on all methods calls. Use SeparateReceipt property to request shipping label & Customer Online Record be printed on 2 separate pages. Enter True if you want this option, or False is you want those to be printed on the same single page. False is assumed if no value is entered.
ServiceType Property (USPSShip Class)
Identifies the USPS service type (applicable to US domestic shipments) to use in a ship request.
Syntax
public int getServiceType(); public void setServiceType(int serviceType); Enumerated values: public final static int stUnspecified = 0; public final static int stFedExPriorityOvernight = 10; public final static int stFedExStandardOvernight = 11; public final static int stFedExFirstOvernight = 12; public final static int stFedEx2Day = 13; public final static int stFedExExpressSaver = 14; public final static int stFedExGround = 15; public final static int stFedExGroundHomeDelivery = 16; public final static int stFedEx1DayFreight = 17; public final static int stFedEx2DayFreight = 18; public final static int stFedEx3DayFreight = 19; public final static int stFedExInternationalPriority = 20; public final static int stFedExInternationalEconomy = 21; public final static int stFedExInternationalFirst = 22; public final static int stFedExInternationalPriorityFreight = 23; public final static int stFedExInternationalEconomyFreight = 24; public final static int stFedExEuropeFirstInternationalPriority = 25; public final static int stFedExSmartPost = 26; public final static int stFedEx2DayAM = 27; public final static int stFedExFirstFreight = 28; public final static int stFedExInternationalGround = 29; public final static int stFedExFreightEconomy = 30; public final static int stFedExFreightPriority = 31; public final static int stFedExInternationalPriorityExpress = 32; public final static int stFedExInternationalConnectPlus = 33; public final static int stUPSFirstClass = 35; public final static int stUPSPriorityMail = 36; public final static int stUPSExpeditedMailInnovations = 37; public final static int stUPSPriorityMailInnovations = 38; public final static int stUPSEconomyMailInnovations = 39; public final static int stUPSNextDayAir = 40; public final static int stUPSExpress = 41; public final static int stUPS2ndDayAir = 42; public final static int stUPSGround = 43; public final static int stUPSWorldwideExpress = 44; public final static int stUPSWorldwideExpedited = 45; public final static int stUPSExpedited = 46; public final static int stUPSStandard = 47; public final static int stUPS3DaySelect = 48; public final static int stUPSNextDayAirSaver = 49; public final static int stUPSSaver = 50; public final static int stUPSNextDayAirEarlyAM = 51; public final static int stUPSExpressEarlyAM = 52; public final static int stUPSWorldwideExpressPlus = 53; public final static int stUPSExpressPlus = 54; public final static int stUPS2ndDayAirAM = 55; public final static int stUPSTodayStandard = 56; public final static int stUPSTodayCourrier = 57; public final static int stUPSTodayInterCity = 58; public final static int stUPSTodayExpress = 59; public final static int stUPSTodayExpressSaver = 60; public final static int stUPSWorldwideExpressFreight = 61; public final static int stUPSSurePostLessThan1LB = 62; public final static int stUPSSurePost1LBOrGreater = 63; public final static int stUPSSurePostBPM = 64; public final static int stUPSSurePostMedia = 65; public final static int stUSPSExpress = 70; public final static int stUSPSFirstClass = 71; public final static int stUSPSPriority = 72; public final static int stUSPSParcelPost = 73; public final static int stUSPSBPM = 74; public final static int stUSPSMedia = 75; public final static int stUSPSLibrary = 76; public final static int stUSPSOnline = 77; public final static int stUSPSGlobalExpress = 78; public final static int stUSPSParcelSelect = 79; public final static int stUSPSCriticalMail = 80; public final static int stUSPSStandardMail = 81; public final static int stUSPSExpressMailInternational = 82; public final static int stUSPSFirstClassMailInternational = 83; public final static int stUSPSPriorityMailInternational = 84; public final static int stUSPSPriorityExpress = 85; public final static int stUSPSRetailGround = 86; public final static int stUSPSFirstClassPackageInternationalService = 87; public final static int stUSPSPriorityMailExpressInternational = 88; public final static int stCanadaRegularParcel = 90; public final static int stCanadaExpeditedParcel = 91; public final static int stCanadaXpresspost = 92; public final static int stCanadaLibrary = 93; public final static int stCanadaPriority = 94; public final static int stCanadaPriorityEnvelopeUSA = 95; public final static int stCanadaPriorityPakUSA = 96; public final static int stCanadaPriorityParcelUSA = 97; public final static int stCanadaXpresspostUSA = 98; public final static int stCanadaExpeditedParcelUSA = 99; public final static int stCanadaSmallPacketAirUSA = 100; public final static int stCanadaTrackedPacketUSA = 101; public final static int stCanadaTrackedPacketLVMUSA = 102; public final static int stCanadaPriorityEnvelopeInternational = 103; public final static int stCanadaPriorityPakInternational = 104; public final static int stCanadaPriorityParcelInternational = 105; public final static int stCanadaXpresspostInternational = 106; public final static int stCanadaSmallPacketAirInternational = 107; public final static int stCanadaSmallPacketLandInternational = 108; public final static int stCanadaParcelAirInternational = 109; public final static int stCanadaParcelLandInternational = 110; public final static int stCanadaTrackedPacketInternational = 111; public final static int stFedExDistanceDeferred = 120; public final static int stFedExNextDayAfternoon = 121; public final static int stFedExNextDayEarlyMorning = 122; public final static int stFedExNextDayEndOfDay = 123; public final static int stFedExNextDayFreight = 124; public final static int stFedExNextDayMidMorning = 125; public final static int stFedExSameDay = 126; public final static int stFedExSameDayCity = 127; public final static int stFedExSameDayMetroAfternoon = 128; public final static int stFedExSameDayMetroMorning = 129; public final static int stFedExSameDayMetroRush = 130; public final static int stUPSWorldwideEconomyDDU = 131; public final static int stUPSWorldwideEconomyDDP = 132; public final static int stUSPSParcelSelectGround = 133; public final static int stUSPSPriorityMailCubic = 134;
Default Value
0
Remarks
This property is required to be provided in a ship request when the GetPackageLabel method is called.
Valid values for USPS are:
Value | USPS | USPS(Endicia) | USPS(Stamps.com) | |
stUSPSExpress (70) | X | X | X | |
stUSPSFirstClass (71) | X | X | X | |
stUSPSPriority (72) | X | X | X | |
stUSPSParcelPost (73) | X | X | X | |
stUSPSMedia (75) | X | X | X | |
stUSPSLibrary (76) | X | X | X | |
stUSPSParcelSelect (79) | X | X | ||
stUSPSCriticalMail (80) | X | X | ||
stUSPSStandardMail (81) | X | |||
stUSPSRetailGround (86) | X | |||
stUSPSPriorityExpress (85) | X | X | ||
stUSPSBPM (74) | X | |||
stUSPSParcelSelectGround (133) | X | |||
stUSPSPriorityMailCubic (134) | X |
Please note that the ServiceType stUSPSBPM (74) is no longer supported by Endicia.
This property is not available at design time.
ShipDate Property (USPSShip Class)
Date package will be mailed.
Syntax
public String getShipDate(); public void setShipDate(String shipDate);
Default Value
""
Remarks
You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.
This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.
Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.
This property is also returned after the following carrier pickup methods are called:
This indicates the date on which the packages will be picked up from the specified location.ShipmentSpecialServices Property (USPSShip Class)
Contains the collection of special services offered by USPS on shipment level.
Syntax
public long getShipmentSpecialServices(); public void setShipmentSpecialServices(long shipmentSpecialServices);
Default Value
0
Remarks
To request any of the special services offered by USPS, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x0000000000000004L | COD |
0x0000000000008000L | Hold For Pickup |
0x0000000008000000L | Return Shipment |
0x0000000080000000L | Restricted Delivery |
0x0000000100000000L | Return Receipt |
0x0000000200000000L | Certificate Of Mailing |
0x0000000400000000L | Sunday and Holiday Delivery |
0x0000000800000000L | No Weekend |
0x0000001000000000L | Registered Mail |
0x0000002000000000L | Premium Service (Sunday/Holiday) |
0x0000004000000000L | Commercial |
0x0000008000000000L | Delivery Confirmation |
0x0010000000000000L | Electronic Return Receipt |
SSLAcceptServerCert Property (USPSShip Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
SSLCert Property (USPSShip Class)
The certificate to be used during SSL negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
SSLProvider Property (USPSShip Class)
This specifies the SSL/TLS implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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 the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
SSLServerCert Property (USPSShip Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
StandardizeAddress Property (USPSShip Class)
Checks the delivery address against the USPS Address Matching System.
Syntax
public boolean isStandardizeAddress(); public void setStandardizeAddress(boolean standardizeAddress);
Default Value
False
Remarks
Set StandardizeAddress to True if you want the class to check the delivery address for accuracy. Identified errors will be returned to allow you to correct them.
Timeout Property (USPSShip Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use 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 throws an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TotalWeight Property (USPSShip Class)
The estimated weight for the package to be picked up.
Syntax
public int getTotalWeight(); public void setTotalWeight(int totalWeight);
Default Value
0
Remarks
Enter the total estimated aggregate weight (in pounds) of all packages being picked up.
This property is required when the following methods are called:
and retrieved in the:- PickupInquiry method call.
TransactionId Property (USPSShip Class)
The transaction Id.
Syntax
public String getTransactionId(); public void setTransactionId(String transactionId);
Default Value
""
Remarks
This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.
USPSAccount Property (USPSShip Class)
Login information for USPS.
Syntax
public USPSAccount getUSPSAccount(); public void setUSPSAccount(USPSAccount USPSAccount);
Remarks
This property must be set when connecting to USPS servers. It contains server and login information.
CancelPackage Method (Uspsship Class)
Cancels a single package by deleting it from the eVS shipping log.
Syntax
public String cancelPackage(String barcodeNumber);
Remarks
The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.
The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the TrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.
If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.
CancelPickup Method (Uspsship Class)
Cancels a scheduled Carrier Pickup request.
Syntax
public String cancelPickup(String confirmationNumber);
Remarks
When the CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.
You must enter the following information:
- ConfirmationNumber (required)
- Company (optional)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode(required)
The confirmation number alone cannot be used to cancel or change a scheduled pickup. You must also supply address information that is identical to what was originally entered when the pickup was scheduled with SchedulePickup.
If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method fills the original pickup address and tracking number as well as the Status property.
You may submit your cancellation to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be canceled online.
If you miss the deadline for canceling your pickup, or if you did not save the ConfirmationNumber or address information, you should put a note at the PackageLocation you specified in the original SchedulePickup request explaining that you wish to cancel the pickup.
The return value for this method is a string containing the status of the cancellation.
ChangePickup Method (Uspsship Class)
Changes requested data in your original Pickup Schedule request and schedules a new pickup.
Syntax
public String changePickup(String confirmationNumber);
Remarks
When the ChangePickup method is called, the exact data from the original SchedulePickup request must be entered, with whatever changes you wish to enter. It is recommended that you first send a PickupInquiry to fill all the properties, edit the property you wish to change, and then submit a ChangePickup request.
At the minimum, you must enter the pickup address information, number of packages for the service requested, estimated weight, package location, weight, special pickup instructions and confirmation number. The confirmation number alone cannot be used to cancel or change a scheduled pickup.
The name and phone number of the sender can be changed, along with the number and types of package services, weight, and the location of the pickup.
Address data and the confirmation number cannot be changed and must be identical to the original SchedulePickup request (supplied to and returned by SchedulePickup method when first called).
After a successful call, this method fills the following properties:
- ConfirmationNumber (required)
- FirstName (required)
- LastName (required)
- Company (optional)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode(required)
- Phone (optional)
- TotalWeight (required - value may be changed from the original request)
- CountExpress (optional if CountPriority is provided - value may be changed from the original request)
- CountPriority (optional if CountExpress is provided - value may be changed from the original request)
- CountInternational (optional - value may be changed from the original request)
- CountOther (optional - value may be changed from the original request)
- PackageLocation (required - value may be changed from the original request)
- SpecialInstructions (optional - value may be changed from the original request)
To verify the accuracy of your data, you can call the PickupInquiry method. However, the confirmation number cannot be retrieved online. If you need to change or cancel your Carrier Pickup request, please leave notification (at the Package Location you indicated in your Carrier Pickup request) that provides details of your Carrier Pickup change or cancellation.
If the information entered is valid (matches the existing record and is within the time frames available for pickup change), this method will return the Status of the request and fill the sender's information and pickup address (properties listed above), and also the following properties:
- TotalWeight
- CountExpress
- CountPriority
- CountInternational
- CountOther
- PackageLocation
- SpecialInstructions
- ConfirmationNumber
- ShipDate
- CarrierRoute
You may submit your changes to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be changed online.
Config Method (Uspsship Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String 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.
GetPackageLabel Method (Uspsship Class)
Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.
Syntax
public void getPackageLabel();
Remarks
When this method is called, the following properties are used to construct the request:
- Server (required)
- AccountNumber (required for Endicia shipments)
- UserId (required)
- Password (required)
- LabelImageType (required)
- SenderAddress (required)
- SenderContact (optional)
- RecipientAddress (required)
- RecipientContact (optional)
- Packages (required)
- ServiceType (required)
- ExtraServices (optional)
- Contents (required)
- ContentDescription (optional)
- PriceOption (optional)
- Machinable (optional)
- DeliveryOption (optional)
- Notify (optional)
- PackageNumber (optional)
- TotalPackages (optional)
- ShipDate (optional)
- HoldForManifest (optional)
- MailingLocation (optional)
- CustomerId (optional)
- CRID (optional)
- MID (optional)
- LogisticsManagerMID (optional)
This method fills in the following fields:
- TrackingNumber
- BarcodeNumber
- ShippingLabel
- NetCharge (only for Endicia and Express labels);
- ShipDate (only for Endicia)
- CustomerReceipt
PickupAvailability Method (Uspsship Class)
Checks the availability of a Carrier Pickup service for the given address.
Syntax
public void pickupAvailability();
Remarks
The PickupAvailability method requires the values for the following properties:
- Company (optional)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode (either the ZipCode or City and State are required)
After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your packages:
PickupInquiry Method (Uspsship Class)
Retrieves the data submitted in your original SchedulePickup request.
Syntax
public void pickupInquiry(String confirmationNumber);
Remarks
This method requires: the exact pickup address and confirmation number returned in the SchedulePickup request (when the SchedulePickup method was called). This method will fill the following properties:
- Company (optional)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode (either the ZipCode or City and State are required)
- ConfirmationNumber (required)
On valid request, returns the information that was originally entered in SchedulePickup call: the sender's information and pickup address (properties listed above) and also the following:
- TotalWeight
- CountExpress
- CountPriority
- CountInternational
- CountOther
- ShipDate
- ConfirmationNumber
- PackageLocation
- SpecialInstructions
The PickupInquiry method is very useful for the ChangePickup request. PickupInquiry will retrieve the data from your original request, and you can then change whatever properties you like and then call ChangePickup.
Reset Method (Uspsship Class)
Resets the internal state of the class and all properties to their default values.
Syntax
public void reset();
Remarks
The Reset method does not have any parameters and does not return any value.
SchedulePickup Method (Uspsship Class)
Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.
Syntax
public String schedulePickup();
Remarks
This method allows users to make a Carrier Pickup request.
The SchedulePickup method requires the values for the following properties:
- FirstName (required)
- LastName (required)
- Company (optional)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode(required)
- Phone (required)
- TotalWeight (required)
- CountExpress (optional if CountPriority is provided)
- CountPriority (optional if CountExpress is provided)
- CountInternational (optional)
- CountOther (optional)
- PackageLocation (required)
- SpecialInstructions (optional)
After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your
Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.
There must be at least one Express Mail Package or Priority Mail package to make this call a valid request. Either one of the CountPriority, CountExpress, CountInternational or CountOther properties are required for a valid request.
The Confirmation Number will be returned after a successful request.
Error Event (Uspsship Class)
Information about errors during data delivery.
Syntax
public class DefaultUspsshipEventListener implements UspsshipEventListener { ... public void error(UspsshipErrorEvent e) {} ... } public class UspsshipErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Notification Event (Uspsship Class)
Notification returned by the server upon successful request (if applicable).
Syntax
public class DefaultUspsshipEventListener implements UspsshipEventListener { ... public void notification(UspsshipNotificationEvent e) {} ... } public class UspsshipNotificationEvent { public String message; }
Remarks
When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.
Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.
SSLServerAuthentication Event (Uspsship Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultUspsshipEventListener implements UspsshipEventListener { ... public void SSLServerAuthentication(UspsshipSSLServerAuthenticationEvent e) {} ... } public class UspsshipSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; }
Remarks
This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.
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 (Uspsship Class)
Shows the progress of the secure connection.
Syntax
public class DefaultUspsshipEventListener implements UspsshipEventListener { ... public void SSLStatus(UspsshipSSLStatusEvent e) {} ... } public class UspsshipSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
AddressDetail Type
Represents the address details of a sender or recipient.
Remarks
This type contains descriptive data of physical location of a sender or recipient.
Example: Setting the fields of a sender
SenderAddress addr = new SenderAddress
addr.Address1 = "100 Somewhere St."
addr.Address2 = "Ste 100"
addr.City = "Raleigh"
addr.State = "NC"
addr.ZipCode = "27154"
addr.CountryCode = "US"
The fields contained by this type are listed below.
Fields
Address1 String |
Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS Address1 should not exceed 35 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Address2 String |
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS Address2 should not exceed 35 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddressFlags int |
Various flags that denote information about the address.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
City String |
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CountryCode String |
Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2. Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.
* Not supported by USPS ** Has multiple values, the values used for USPS are below
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
State String |
State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ZipCode String |
Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present. Valid characters: A-Z; 0-9; a-z. Maximum length: 16. |
Constructors
public AddressDetail();
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate String |
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
Encoded String |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
EncodedB byte[] |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExpirationDate String |
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExtendedKeyUsage String |
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). |
||||||||||||||||||||||||||||||||||||||||||||||||
Fingerprint String |
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA1 String |
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA256 String |
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53 |
||||||||||||||||||||||||||||||||||||||||||||||||
Issuer String |
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
KeyPassword String |
This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys. Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKey String |
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyAvailable boolean |
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication). |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyContainer String |
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKey String |
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyAlgorithm String |
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyLength int |
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. |
||||||||||||||||||||||||||||||||||||||||||||||||
SerialNumber String |
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||
SignatureAlgorithm String |
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
Store String |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. 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. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreB byte[] |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. 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. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType int |
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 field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
This is the subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store. 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 displayed below.
If a field value contains a comma it must be quoted. |
||||||||||||||||||||||||||||||||||||||||||||||||
SubjectAltNames String |
This field contains comma-separated lists of alternative subject names for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintMD5 String |
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA1 String |
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA256 String |
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
Usage String |
This field contains the text description of UsageFlags. This value will be of one or more of the following strings and will be separated by commas:
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. |
||||||||||||||||||||||||||||||||||||||||||||||||
UsageFlags int |
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
Please see the Usage field for a text representation of UsageFlags. This functionality currently is not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||
Version String |
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3". |
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate( certificateData);
Parses CertificateData as an X509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
ContactDetail Type
Represents the contact information.
Remarks
This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).
Example: Setting the fields of the sender
ContactDetail senderContact = new ContactDetail
senderContact.Company = "Anything Anywhere"
senderContact.FirstName = "John"
senderContact.LastName = "Doe"
senderContact.Phone = "1234567890"
senderContact.Email = "test@test.com"
The fields contained by this type are listed below.
Fields
Company String |
Identifies the contact person's company name. In a ship request, either FirstName and LastName or Company are required to be provided. |
Email String |
Identifies the contact person's email address. Maximum length: 120. |
Fax String |
Recipient's fax number. The value of this field is optional. No format checking is done on international fax numbers. |
FirstName String |
Sender's first name. The value of this property is required. Values for either FirstName and LastName or Company must be sent. |
LastName String |
Person's last name. The value of this field is required. Values for either FirstName and LastName or Company must be sent. Maximum length: 45 characters for both names or company name. |
MiddleInitial String |
Middle initial. The value of this field is optional. |
Phone String |
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15. |
Constructors
public ContactDetail();
public ContactDetail( firstName, lastName, phone);
public ContactDetail( firstName, lastName, phone, email);
public ContactDetail( firstName, lastName, phone, email, company);
Firewall Type
This is the firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect boolean |
This field tells the class whether or not to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). |
||||||||||
FirewallType int |
This field determines the type of firewall to connect through. The applicable values are as follows:
|
||||||||||
Host String |
This field contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. |
||||||||||
Password String |
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. |
||||||||||
Port int |
This field contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host field for details. Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||||
User String |
This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception. |
Constructors
public Firewall();
NotifyDetail Type
Represents a single recipient to be notified via email.
Remarks
This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.
In FedEx, this type is also used to specify recipients of Signature Proof of Delivery (SPOD) via fax.
The fields contained by this type are listed below.
Fields
Aggregate String |
This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices. FedEx For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment. The format of this aggregate should be as follows:
In this aggregate, you can specify:
This setting is optional. If Aggregate is not set it will be automatically created by the class. UPS For UPS, the following format is valid:
In this aggregate, you can specify:
Note that this field does not apply for USPS and CanadaPost. |
||||||||||||||||||||||||||
Email String |
Email address of the recipient to be notified. This is required to be provided for each recipient. |
||||||||||||||||||||||||||
Fax String |
Fax number of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Fax is required. In this case, the Name should be provided as well. Note this is only used by FedEx. |
||||||||||||||||||||||||||
Message String |
User defined text that will be included in the email to be sent to Email. This is optional. For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email. This field is not used by USPS or Canada Post. |
||||||||||||||||||||||||||
Name String |
The name associated with the notification. For FedEx, this is the name of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Name is required. In this case, the Fax should be provided as well. For USPS, this name will appear in the text of the Signature Confirmation e-mail message. This field is not applicable to UPS or Canada Post. |
||||||||||||||||||||||||||
NotificationFlags int |
Identifies the type of notification requested. Valid values are:
For FedEx notifications, the following flags apply:
For UPS notifications, the following flags apply:
For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply. This field is not used by USPS. |
||||||||||||||||||||||||||
RecipientType int |
Identifies the set of valid email notification recipient types. Valid values are:
For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the Email specified for these types will be ignored. For USPS, only the rtShipper and rtRecipient are valid. This field does not apply to UPS or Canada Post notifications. |
Constructors
public NotifyDetail();
public NotifyDetail( notificationFlags, email, message);
public NotifyDetail( notificationFlags, email);
public NotifyDetail( notificationFlags, recipientType, email);
public NotifyDetail( name, fax);
PackageDetail Type
Represents a single package contained in shipment.
Remarks
This type contains specific information on the package that is part of the whole shipment.
Example: Setting the package elements
PackageDetail pckg = new PackageDetail
pckg.Weight = "2.0"
pckg.Description = "Your order for the 4D Shipping SDK"
pckg.ShippingLabelFile = "shipping label for package# 1.pdf"
The fields contained by this type are listed below.
Fields
BaseCharge String |
Base charge applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on the package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater. This is not applicable to USPS. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODAmount String |
The COD monetary value for the package. For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service. Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in CODLabel). On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead. For UPS, if the CODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the CODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by SignatureType) and COD cannot coexist on a single package. This field is not applicable to USPS packages. Format: Two explicit decimal positions (e.g. 100.00). This is not applicable for Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODFile String |
Filename and location to save the CODLabel of this package to. This is applicable for package(s) that use the COD service. When the CODFile is set to a valid path and filename, the contents of the CODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called. This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then CODFile has to have .pdf extension). If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). This field is only applicable to FedEx shipments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODLabel String |
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request. This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service. On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS. This field is only applicable to FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODLabelB byte[] |
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request. This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service. On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS. This field is only applicable to FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODType int |
The code that indicates the type of funds that will be used for the COD payment for this package. This field is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., CODAmount is set to a value other than "0.00"). Valid values are:
Note: COD special service is not valid for return service movements. Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DangerousGoodsAccessible boolean |
Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery. This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices contains the corresponding flag for Dangerous Goods. There are two types of dangerous goods:
Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DangerousGoodsOptions int |
Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:
Note: This is only valid when using FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description String |
For FedEx, this is the description that appears in the email to identify this package. This is optional. For UPS, this is applicable and required for shipments with return service only. This does not apply for USPS and Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Girth int |
Measurement around the widest part of the package, perpendicular to the Length. This field is only applicable when requesting rates for USPS packages. Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Height int |
The height of the package to be shipped. For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Id String |
An 8-digit Unique Parcel Identification Number. Unique number used to identify the package. This field is optional, and only applies to USPS return labels. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InsuredValue String |
Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Length int |
The length of the package to be shipped. For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. Valid values are 0 to 108 IN and 0 to 270 CM. For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Note: For parcels, the Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NetCharge String |
Net charge applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment. For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response. This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackagingType int |
The packaging type of the package being rated and/or shipped. Possible values are:
If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0), except for with FedEx, in which case it will default to ptLetter (2). For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagingType for the first package is used in label requests. If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height. If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagingType will be automatically set to 31 (Your Packaging). Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States. For UPS, please note that when selecting PackagingType make sure this is valid for all the following: CountryCode, CountryCode, ServiceType, and all special services requested at both shipment and package level. Also the following restrictions apply when using UPS Mail Innovations:
For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular. For Canada Post, ptLetter (2) is only applicable if theContractId is set. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatingAggregate String |
Rating aggregate applicable to this package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference String |
Indicates the package reference type and value, that associates this package (assigned by the customer). For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request. Valid values for types are:
The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the Reference should be set to: CN:123456; IN:123; SN:12;. Reference information may also be used to track packages by reference. For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR. You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request. Valid values for types are:
The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the Reference should be set to: 'AJ:123456; TN:123'. You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True. Reference information may also be used to track packages by reference. For USPS, this is only used by Endicia labels, and is used as a reference value for logs. This is used in Canada Post to provide user-defined values, such as an internal "orderID". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceipt String |
Image of the receipt for a return shipment. This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceiptB byte[] |
Image of the receipt for a return shipment. This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceiptFile String |
Filename and location to save the ReturnReceipt of this package to. This is applicable only if using UPS. When the ReturnReceiptFile is set to a valid path and filename, the contents of the ReturnReceipt are written to disk upon successful response (if a return shipment). The ReturnReceiptFile has to have .html extension. Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabel String |
Image of the shipping label for this package returned by the Server upon a successful ship response. This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelB byte[] |
Image of the shipping label for this package returned by the Server upon a successful ship response. This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelFile String |
Filename and location to save the ShippingLabel of this package to. When the ShippingLabelFile is set to a valid path and filename, the contents of the ShippingLabel are written to disk upon successful response. This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then ShippingLabelFile has to have .gif extension). If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelPart2 String |
Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS. This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format. For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif". Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelPart2B byte[] |
Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS. This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format. For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif". Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SignatureType int |
Specifies one of the Delivery Signature Options requested for this package. Possible values are:
For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods. For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct. The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:
Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment. For UPS, when delivery confirmation is requested for a package, the SignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages. Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation. Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option. For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements. This does not apply for Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Size int |
Size of the package being mailed. This field is only used by USPS and is required for the GetRates method call. See below for valid entries:
Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note: Use the Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package. Note: only psRegular and psLarge are available when getting rates for international shipments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SpecialServices long |
Contains the collection of special services offered on the package level. Valid values are:
For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the SpecialServices of that package to a set of valid flags. The meaning and limitations for each special service option are listed below for FedEx:
For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the SpecialServices of that package to a set of valid flags. The meaning and limitations for each special service option are listed below:
Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the CODAmount and CODType, SignatureType, and InsuredValue. This field is not applicable to USPS or Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalDiscount String |
Total discount applicable to this package. This is specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalSurcharges String |
Total surcharges applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment. This does not apply to USPS packages. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TrackingNumber String |
Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Weight String |
Weight of this package. For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting). For UPS, this is required to be provided in the request for each package contained in the shipment if PackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting). Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set. For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country. The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104". However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting). For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Width int |
The width of the package to be shipped. For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern). |
Constructors
public PackageDetail();
public PackageDetail( packagingType, weight);
public PackageDetail( length, width, height);
public PackageDetail( packagingType, length, width, height);
public PackageDetail( packagingType, weight, length, width, height);
public PackageDetail( packagingType, weight, length, width, height, specialServices, insuredValue, CODAmount, CODType, signatureType);
public PackageDetail( weight, length, width, height, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType);
public PackageDetail( weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType, shippingLabelFile, CODFile);
public PackageDetail( packagingType, weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, CODType, signatureType, shippingLabelFile, returnReceiptFile);
Proxy Type
This is the proxy the class will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme int |
This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set. AuthScheme should be set to authNone (3) when no authentication is expected. By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead. If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of User and Password. |
||||||||
AutoDetect boolean |
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false. Note: This setting is applicable only in Windows. |
||||||||
Password String |
This field contains a password if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
||||||||
Port int |
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details. |
||||||||
Server String |
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
SSL int |
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
|
||||||||
User String |
This field contains a user name, if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
Constructors
public Proxy();
public Proxy( server, port);
public Proxy( server, port, user, password);
USPSAccount Type
Represents the details of a USPS account.
Remarks
This type contains data describing the USPS server and login information.
Example: Setting the fields of an account
USPSAccount account = new USPSAccount
account.Server = "https://secure.shippingapis.com/ShippingAPI.dll";
account.Password = "my_password";
account.UserId = "my_username";
The fields contained by this type are listed below.
Fields
AccountNumber String |
The shipper's Endicia account number. This field is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set. |
||||||||
Password String |
Password to use for logging in to the USPS Server. This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility. When PostageProvider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration. |
||||||||
Server String |
URL for the USPS server where the requests are sent. When PostageProvider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode. When PostageProvider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode. There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these classs). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the classs that use them. Live Servers:
Test Servers:
These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account. Note that the label components must use the live server for testing, but with the Certify configuration setting set to True. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead. |
||||||||
UserId String |
User Id for logging in to the USPS WebTools or Stamps.com Server. This User Id is provided to you by USPS or Stamps.com when you register for service. The UserId is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia. |
Constructors
public USPSAccount();
Config Settings (Uspsship Class)
The class accepts one or more of the following configuration settings. Configuration 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.USPSShip Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ActionCode:
Use to specify the Action Code.Use this config setting to specify the Action Code. The Value is included in the Shipping Partner Event file
for customers who have chosen to have a Shipping Partner Event file submitted to USPS on their behalf.
Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnAggregate[i]:
Indicates the AddOn raw XML.This configuration setting returns the raw xml of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnAmount[i]:
Indicates the AddOn amount.This configuration setting indicates the amount of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnCount:
Total number of AddOns.This configuration setting returns the total AddOn elements for each service.
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnType[i]:
Indicates the AddOn type.This configuration setting indicates the AddOn type in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnTypeDescription[i]:
Indicates the AddOn description.This configuration setting indicates the textual description of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnTypes:
The AddOn type to be requested.This configuration setting is used to request specific AddOns.
This setting accepts multiple, comma separated, AddOns. For example:
Note: This configuration setting is read-only and valid only for Stamps.com. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowBadAddress: Indicates whether the destination and origin addresses should be verified.Set this config setting to True to bypass failures/errors of Street Address validation or set it to False if only validated addresses should be allowed. Valid for USPS only. Default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CarrierRelease:
Indicates if the CARRIER LEAVE IF NO RESPONSE is to be printed on the eVS Domestic Labels.The default value for this config is False. If set to True, the "CARRIER - LEAVE IF NO RESPONSE" will be printed on the eVS label.
Note: This endorsement cannot be applied to Express Mail or items requiring a signature at delivery. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CarrierRoute:
The carrier route.This can be "C" for City, "H" for Highway, "R" for Rural.
This property will be set and returned in the PickupAvailability and SchedulePickup methods calls. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Certify: Certify/Test mode for label components.If True a Certify request is sent instead of a regular production request. In this manner test labels may be created on a live Server. The default value for this setting is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContentDescription:
Content Description of a package.Use this config setting to specify the content description of the package. This setting is required when Contents
is set to ctLives.
The valid values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CRID: Customer Registration ID.The Customer Registration ID (CRID) is provided to you by USPS. It is a unique number that identifies a specific location involved in a mailing. Customers must have a CRID in order to submit electronic documenation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CustomerId2:
User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.You can set a value to CustomerId2 config setting as well as CustomerId property if you have a
need to cross-reference information about a shipment using your own tracking or inventory systems. Any
combination of alpha and numeric characters can be entered, up to a maximum of 30.
Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId2 value on the shipping label image if you set the PrintCustomerRefNo2 to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMCAAccount: For future use.This is for future use, and is not currently supported by USPS. For now, do not enter any value. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EMCAPassword: For future use.This is for future use, and is not currently supported by USPS. For now, do not enter any value. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODAS3816:
Indicates whether the 2-part Form AS3816 will be used.Indicates whether the 2-part Form AS3816 will be used when generating Endicia COD labels.
When True, a two part 3816 form will be returned. When False (default), a four part 3816 form will be returned. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODEndorsement: Optional endorsement string on the form.Optional endorsement string used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODPMExpressReturn: Indicates whether the COD is to be returned by Express Mail.Indicates whether the COD is to be returned by Express Mail, used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODReturnAddress1: Return Addressee's Address Line 1.The street name used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODReturnCity: Return Addressee's City.The city used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODReturnName: Return Addressee's name.The return name used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODReturnPostalCode: Return Addressee's Postal Code.The postal code used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODReturnState: Return Addressee's State.The state used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCODUSPSCA: USPS Corporate Account Number.The USPS Corporate Account Number used when generating Endicia COD labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaCostCenter:
Cost-center code for accounting purposes.Cost-center code for accounting purposes.
Note: This setting is valid only for Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaHazMatDescription:
HazMat Description.This specifies the dangerous goods categories.
The valid values are as follows:
This is only valid when using Endicia's DHL consolidator services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaHazMatPhone:
HazMat phone number.This specifies the HazMat phone number.
This is only valid when using Endicia's DHL consolidator services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaInsuranceType:
The Insurance type when using Endicia.This will determine which type of insurance will be used when requesting a label through Endicia.
Note that if this is set to None, and an insurance amount is provided, Endicia Insurance will be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaInsuredMail:
Used to request Endicia mailpiece insurance.When set to False, Endicia mailpiece insurance will not be requested. This can be applicable when generating Endicia COD labels.
When InsuredValue is set, the default value for this configuration setting is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaLabelType:
The Endicia label type to be used.This allows you to set the Endicia Label type. Setting this to Default(0), will create a label based on the mail class (ie Domestic or International).
Setting this to Certified Mail(1) will create a Certified Mail label, and setting this to Destination Confirm(2) will create a label with an Intelligent
Mail barcode, which requires special permission from Endicia.
Here is a list of each type and the label sizes that you can use with it:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaMailClass: Specifies the mail class used with the Consolidator Service request.This setting is used to specify the mail class when EndiciaPrintConsolidatorLabel is set to True. By default the class will attempt to determine the mail class, but this setting may be used to specify the mail class directly. For instance "DHLGMSMParcelPlusGround". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaPrintConsolidatorLabel:
Used to request Consolidator Services.When set to True, Endicia Label Server will generate USPS workshare labels for consolidators that partner with Endicia. The default value is false.
Note that your Endicia account must be first activated for Consolidator Services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaPrintScanBasedLabel:
Used to request Pay-on-Use Returns.When set to True, postage is not deducted from a shipper's Endicia postage account at the time the label is printed. Funds are only deducted if and when the label is scanned in the USPS mail stream. The default value is false.
Pay-on-Use Returns are available for domestic shipments only. The following mail classes and extra service combinations are supported:
To use this functionality, customers must work with an Endicia Sales Representative to agree to program-specific terms and conditions and to enable their existing Endicia postage account for Pay-on-Use Returns. Accounts that are not internally enabled by Endicia will not be able to print Pay-on-Use Return shipping labels. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaReplyPostage:
Used to request postage paid return labels.When set to True, a postage paid return label will be enclosed in your outbound shipments.
This is only applicable when EndiciaLabelType is 0 (default) or 2 (Destination Confirm). It is also not applicable when ServiceType is set to stUSPSExpress or if the 0x00100000000L (Return Receipt) flag in ShipmentSpecialServices is set. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaTestMode:
Controls whether requests are test requests or live requests.When set to a non-zero value the class will use a built-in sandbox account and set the TEST flag to "Yes" in the request itself. For all values this will automatically set Server as defined below.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaValidateAddress:
Defines if the address should be validated or not.If True (default value) the SenderAddress and the RecipientAddress are validated. Set it to False if you wish to bypass the address validation.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EntryFacility:
Postal facility where mail is entered.This specifies the postal facility where the mail is to be entered. If this is not set to Other and the postal
facility's zip code is different than your return address zip code (ZipCode), then you must specify
a zip code in MailingLocation
The valid values are as follows:
This is required when the ServiceType is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EscapeEndiciaXML:
Whether to escape XML special characters when using Endicia.When set to true, XML special characters will automatically be escaped when using Endicia. Default is false.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
eSOFAllowed: Electronic Signature On File (eSOF) Allowed. Valid for USPS eVS Domestic Labels only.Set this config setting to False if use of Electronic Signature On File (eSOF) be disallowed for the shipment so that a physical or "wet" signature is required. Default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasXPath: Determines whether a specific element exists in the document.This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath. This method returns True if the XPath exists, False if not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HoldForManifest: Holds manifest record for inclusion in SCAN request.This feature is restricted to authorized users only. When True, it indicates that the manifest record should be held for possible inclusion in the SCAN request. Default is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImageParameters: For future use.Setting a value to this configuration setting will fill the <ImageParameters> tag in a label request. The USPS does not support this functionality at this time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludeEndiciaCODForm: Indicates whether the COD labels should be returned in the response.Indicates whether the COD labels should be returned in the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludePostage:
Used to determine if the postage will be printed on the label.When set to true (default), the postage will be included on the label. Otherwise no postage will be printed on the label.
Note that when true, Stealth is also set to true so that the postage price will not be printed on the label. This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IntegratorTxId:
Stamps.com transaction integrator Id.Every time GetPackageLabel method is called a unique IntegratorTxId is generated. In case GetPackageLabel method fails for some reason, this configuration setting can be used to repeat the call. Stamps.com checks if the IntegratorTxId has been used before. If it has been used, the service will treat the call as a replay and simply return the response of the initial call.
Note: This setting is valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelImageResolution:
The resolution of the label.This configuration is only valid when PostageProvider has been set to ppEndicia. The resolution for the image
defaults to 300 DPI for domestic and international labels. For labels with the LabelImageType set to sitEPL
or sitZPL, the image resolution must be set to 203. The following values are valid:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelImageRotation:
The rotation of the label.This configuration is only valid when PostageProvider has been set to ppEndicia. When LabelImageType has been
set to sitEPL or sitZPL, setting this configuration to 2 will print from the top of the image buffer.
Selecting 0 will print from the bottom of the image buffer. Rotating 90 and 270 degrees are not valid for sitEPL
or sitZPL image types. The following values are valid:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelSize:
The size of the label.This configuration is only valid when PostageProvider has been set to ppEndicia or ppStamps. Set this to
one of the following values to change the size of the label that is returned by the server.
Valid Values for Endicia:
Valid values for Stamps.com
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogisticsManagerMID:
Logistics Manager Mailer ID.The Logistics Manager Mailer ID is the MID of the company that manages the mailing and it's assigned by USPS.
Note that if LogisticsManagerMID is populated, either CRID or MID must also be populated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Memo: Customer defined data to be printed on a Stamps shipping label.This config is used to add a user-defined text (memo) to print at the bottom of the Stamps shipping label. The maximum number of characters is 150. For a single line memo, it will print in a single box. For a multi-line memo, the first two lines will be put into the two separate boxes of the label. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MerchandiseReturnNumber:
The number assigned to the return package.If a return service was requested, then this number may be returned in the response and used to track the return package.
Note: This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MID: Mailer ID.The Mailer Identifier (MID) is provided to you by USPS. MID is a field within the Intelligent Mail barcode that is used to identify mailers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NineDigitRoutingZip: Nine Digit Routing Zip. Valid for USPS eVS Domestic Labels only.Use this config setting to indicate if nine-digit routing zip code is to be included in the barcode. Default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OptOutOfSPE: Opt out of Shipping Partner Event file creation.When True (default) allows a customer to opt out of SPE (Shipping Partner Event) file creation. Setting it to False will create a SPE file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Overwrite: Determines whether label files will be overwritten.If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageLabelUrl:
Stamps.com label Url.This configuration setting is populated by Stamps.com after calling GetPackageLabel when LabelImageType is set to sitNone
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageNumber: The package number to be used in the case of multiple packages.Use this config setting to indicate the package number in the case of multiple packages for USPS eVS Labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POZipCode:
ZIP Code of Post Office.This configuration setting is Required when EntryFacility is not set to Other. The value of this element must contain the ZIP Code of the postal facility specified in EntryFacility.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrintCustomerRefNo: Print Customer Reference Number (CustomerId). Valid for USPS eVS Domestic Labels only.Set this config setting to True if you want the CustomerId value to be shown on the shipping label image. Default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrintCustomerRefNo2: Print Customer Reference Number 2 (CustomerId2). Valid for USPS eVS Domestic Labels only.Set this config setting to True if you want the CustomerId2 value to be shown on the shipping label image. It will be positioned below the CustomerId. Default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawRequest: Contains the complete request sent to the Server.This returns the complete request as sent to the server. Used for debugging purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawResponse: Contains the complete response returned by the Server.This returns the complete response as received from the server. Used for debugging purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReceiptOption:
Indicates the Label and Receipt layout options.Use this config setting to indicate that you want the shipping label and the customer receipt printed on two separate pages or the same single page.
The value 0 means no receipt is requested.
The valid values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RegisteredMailValue: The value of registered mail sent in the request. This configuration setting sets the value of registered mail sent in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RequestId:
The ID used to identify a particular request/response pair when tracking Endicia packages.This value is required for Endicia tracking requests, and is also returned in the tracking response.
This setting is only applicable when using Endicia as your postage provider. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp1:
Customer defined data to be printed on label.This contains the first set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp2:
Customer defined data to be printed on label.This contains the second set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp3:
Customer defined data to be printed on label.This contains the third set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormImage:
Image of the PS Form 3152 or PS Form 5630.Image of the SCAN Form retrieved upon a successful USPSCreateManifest request.
The SCAN Form image format can be specified via LabelImageType. The only possible values are sitTIF (1) or sitPDF (3). If the SCANFormImageFile is set to a valid path and filename, the form is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormImageFile: The location where the SCAN Form Image will be written.This should contain the full path to where the SCAN Form Image will be written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormNumber: Returns the Form Number from the last succesful call to USPSCreateManifest. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormType:
Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest.The default value for this config is 0. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANPackageBarcodes:
A list of Package Barcodes to include in the SCAN Request (create a manifest for).Use this config before calling USPSCreateManifest. The value can be one or more Package Barcodes delimited with a semi-colon like this example:
class.Config("SCANPackageBarcodes=9270190317997999997976;9270202901089817001111");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SenderPhoneExt: Sender's phone number extension.If applicable this can be set to specify the sender's phone number extension. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipInfo: Ship Info. Valid for USPS eVS Domestic Labels only.Set this config setting to True if you want the revenue protection information to be printed on the label. Default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipTime:
Time package will be mailed.This indicates the approximate time on which the packages will be tendered to Postal Service. It should be entered in HHmmss (24 hour) format, such as 143000.
Note: This is required when calling USPSCreateManifest. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SortType:
Sort level for applicable mail classes.This specifies the sort level to be used.
The valid values are as follows:
This is required when the ServiceType is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SpecialInstructions:
Special instructions for pickup location.This configuration is optional.
When the SchedulePickup method is called and PackageLocation property is set to plOther, a value for SpecialInstructions property is required to be entered. Maximum characters allowed: 255. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsAPIVersion:
Controls the API version used for requests.
This configuration setting sets instructs the component to work with a specific Stamps.com API version. Available versions are detailed below.
There is no need to additionally set Server when using Stamps.com. The correct server will be used automatically. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifest:
Sends a request to create a manifest for the specified shipments.When called, the component will make a request to create a manifest for the shipments specified in StampsCreateManifestIdentifier. If StampsCreateManifestIdentifier is not set, the manifest will be created for shipments using the value in ShipDate. The manifest will be returned as a string containing a URL. Here is a short C# example.
// Using v71 of Stamps.com's API is required. A different URL needs to be used.
uspsship.USPSAccount.Server = "https://swsim.testing.stamps.com/swsim/swsimv71.asmx";
uspsship.Config("StampsCreateManifestIdentifierType=1"); // For StampsTxIds
uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619");
string manifestURL = uspsship.Config("StampsCreateManifest");
This operation requires a newer version of the API. Please use the appropriate server URL from below when calling StampsCreateManifest.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestId: Returns the ManifestId from the last succesful call to StampsCreateManifest. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestIdentifier:
A list of identifiers to create a manifest for.Set this config to one of the following:
uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619");
A Ship Date should follow this format: YYYY-MM-DD.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestIdentifierType:
Used to indicate the type of identifier used.Set this to the type of identifier used in StampsCreateManifestIdentifier. Possible values include:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsTestMode:
Controls whether requests are test requests or live requests.When set to 0 the class will send requests to Stamps.com's production server using the account specified in USPSAccount. When set to 1 the class will send requests to Stamps.com's sandbox server using a built-in sandbox account. There is no need to set Server in either case.
This setting only applies when PostageProvider is set to ppStamps. The default value is 0. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsTxId:
Stamps.com transaction identifier.This configuration setting is returned by Stamps.com after calling GetPackageLabel This setting can be used later by USPSMgr class to refund a transaction.
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalPackages: The total number of packages to be used in the case of multiple packages.Use this config setting to indicate the total number of packages in the case of multiple packages for USPS eVS Labels. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseStandardPost:
Used to retrieve Standard Post shipping labels.When set to true, this configuration setting can be used to instruct the class to retrieve USPS
Standard Post (formerly Parcel Post) shipping labels. Note that when using this, ServiceType must
be set to stUSPSParcelPost.
Note that there are some restrictions set by USPS for Standard Post packages. We have outlined some of these below:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseStealth:
Used to determine if the postage price is printed on the label.When this is set to true (default), the postage price will not be printed on the label.
Note: Stealth cannot be used with COD, USPS Insurance, Registered Mail, Automation rate, LabelSize of EnvelopeSize10 and Card shape mailpieces. This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USPSCreateManifest:
Sends a SCAN request to create a manifest for the specified shipments.When called, the component will make a request to create a manifest. This is only applicable when using USPS as your postage provider (in other words PostageProvider is set to ppNone).
To create a manifest for one or more packages set the SCANPackageBarcodes config to a list of package barcodes and ShipDate property as well
before calling USPSCreateManifest. For example:
Note: In order for the Shipping Labels to be eligible for inclusion in a SCAN Form you have to set HoldForManifest to true when creating labels using GetPackageLabel method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VendorCode: Vendor Code to identify the developer of the shipping system.Use this config setting to set the Software Vendor Code to identify the developer of the shipping/manifesting system when using the eVS label API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VendorProductVersionNumber: Vendor Product Version Number.Use this config setting to set the shipping Software's Product Version Number when using the eVS label API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrCount: The number of records in the XAttr arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrName[i]: The name of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrValue[i]: The value of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildCount: The number of records in the XChild arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildElement[i]: The name of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildText[i]: The text of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XElement: The name of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XParent: The parent of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Used to set the XPath within the response from the server.XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the RawResponse. XPath is 1-indexed.
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XText: The text of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPCompression:
This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server
does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Append: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authorization:
The Authorization string to be sent to the server.If the Authorization property contains a nonempty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BytesTransferred: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EncodeURL: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FollowRedirects:
Determines what happens when the server issues a redirect.This option 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 1 (always), the new URL for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception. Note: Following the HTTP specification, unless this option is set to 1 (Always), 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, unless this property is set to 1 (Always), in which case 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 0 (Never). In this case, redirects are never followed, and the class throws an exception instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTPVersion:
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.
HTTP/3 NotesHTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAlive:
Determines whether the HTTP connection is closed after completion of the request.If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server
that HTTP persistent connections should be used if supported.
Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive.
If False, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
The level of detail that is logged.This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxHeaders:
Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired.
This value represents the number of headers that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxHTTPCookies:
Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of
cookies that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NegotiatedHTTPVersion: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherHeaders:
Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthorization: The authorization string to be sent to the proxy server.This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthScheme: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPassword: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyServer: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyUser: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredData: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible.
HTTP-chunked encoding allows large files to be sent in chunks instead of all at once.
If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIDNs:
Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UsePlatformHTTPClient: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseProxyAutoConfigURL:
Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallListener:
If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting 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 setting 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). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseNTLMv2: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckOCSP:
Whether to use OCSP to check the status of the server certificate.This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLContextProtocol: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Note: This value must be set after SSLProvider is set. Example values:
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLTrustManagerFactoryAlgorithm: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class throws an exception. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GUIAvailable:
Tells the class whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseDaemonThreads: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (Uspsship Class)
USPSShip Errors
301 Operation interrupted (or timeout). | |
432 Invalid index. | |
527 Server Error Response. | |
528 Property set with invalid data. |
SOAP Errors
169 Invalid param index (out of range). | |
170 Invalid namespace index (out of range). | |
171 Method not found. Please specify a valid Method. | |
172 No method URI. Please specify a valid MethodURI. | |
173 SOAP Fault. See FaultCode and/or FaultString for details. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |
XML Errors
101 Invalid attribute index. | |
102 No attributes available. | |
103 Invalid namespace index. | |
104 No namespaces available. | |
105 Invalid element index. | |
106 No elements available. | |
107 Attribute does not exist. | |
201 Unbalanced element tag. | |
202 Unknown element prefix (can't find namespace). | |
203 Unknown attribute prefix (can't find namespace). | |
204 Invalid XML markup. | |
205 Invalid end state for parser. | |
206 Document contains unbalanced elements. | |
207 Invalid XPath. | |
208 No such child. | |
209 Top element does not match start of path. | |
210 DOM tree unavailable (set BuildDOM to true and reparse). | |
302 Can't open file. | |
401 Invalid XML would be generated. | |
402 An invalid XML name has been specified. |