www.ec-demo.com
Download
Report
Transcript www.ec-demo.com
PLD 0200
Upload a PLD0200 File
and
Receive and Parse the Response
June 2003
PLD Flow Diagram
UPS | EUR Region EBSG
2
PLD0200 upload
http request message
Methode: POST
TCP/IP socket connection
Host:
www.pld-certify.ups.com
PORT:
443
URI:
/hapld/tos/kdwhapltos
URL connection
URL:
https://www.pld-certify.ups.com/hapld/tos/kdwhapltos
PW+ UID: PLDDSTEST
UPS | EUR Region EBSG
3
THE UPLOAD
PLD0200 upload
header
POST /hapld/tos/kdwhapltos HTTP/1.1
Host: www.pld-certify.ups.com
Content-type: multipart/mixed; boundary=BOUNDARY
Content-length: 1038
message
--BOUNDARY
Content-type: application/x-www-form-urlencoded
Content-length: 140
AppVersion=1.0&AcceptUPSLicenseAgreement=Yes&ResponseType=application/x-ups-pld&VersionNumber=V4R1&UserId=xxx&Password=xxx
--BOUNDARY
Content-type: application/x-ups-binary
Content-length: 719
020082 2.0 2002101700000000000010500 000000001*AA0A1754 US 1234567002000001*BA1z1234560100002352 00001+0000000000000010 +0000 000000
--BOUNDARY—
UPS | EUR Region EBSG
5
PLD0200 upload
the PL0200 upload is a multipart message contains 2 part
the two parts are delimited by --Boundary
Multipart message
POST /hapld/tos/kdwhapltos HTTP/1.1
Host: www.pld-certify.ups.com
Content-type: multipart/mixed; boundary=BOUNDARY
Content-length: 1038
--BOUNDARY
Content-type: application/x-www-form-urlencoded
part 1
Content-length: 140
AppVersion=1.0&AcceptUPSLicenseAgreement=Yes&ResponseType=application/x-ups-pld&VersionNumber=V4R1&UserId=xxx&Password=xxx
--BOUNDARY
Content-type: application/x-ups-binary
part 2
Content-length: 719
020082 2.0 2002101700000000000010500 000000001*AA0A1754 US 1234567002000001*BA1z1234560100002352 00001+0000000000000010 +0000 000000
--BOUNDARY—
UPS | EUR Region EBSG
6
PLD0200 upload
each part and the main message has a a Content-type and a content-length header
Multipart message
POST /hapld/tos/kdwhapltos HTTP/1.1
Host: www.pld-certify.ups.com
Content-type: multipart/mixed; boundary=BOUNDARY
Content-length: 1038
--BOUNDARY
Content-type: application/x-www-form-urlencoded
part 1
Content-length: 140
AppVersion=1.0&AcceptUPSLicenseAgreement=Yes&ResponseType=application/x-ups-pld&VersionNumber=V4R1&UserId=xxx&Password=xxx
--BOUNDARY
Content-type: application/x-ups-binary
part 2
Content-length: 719
020082 2.0 2002101700000000000010500 000000001*AA0A1754 US 1234567002000001*BA1z1234560100002352 00001+0000000000000010 +0000 000000
--BOUNDARY—
UPS | EUR Region EBSG
7
PLD0200 upload
the Content-length is one of the most important detail for a successful upload
Multipart message
POST /hapld/tos/kdwhapltos HTTP/1.1
Host: www.pld-certify.ups.com
Content-type: multipart/mixed; boundary=BOUNDARY
Content-length: 1038
--BOUNDARY
Content-type: application/x-www-form-urlencoded
part 1
Content-length: 140
AppVersion=1.0&AcceptUPSLicenseAgreement=Yes&ResponseType=application/x-ups-pld&VersionNumber=V4R1&UserId=xxx&Password=xxx
--BOUNDARY
Content-type: application/x-ups-binary
part 2
Content-length: 719
020082 2.0 2002101700000000000010500 000000001*AA0A1754 US 1234567002000001*BA1z1234560100002352 00001+0000000000000010 +0000 000000
--BOUNDARY—
UPS | EUR Region EBSG
8
THE RESPONSE
PLD0200 RESPONSE
the PLP0200 upload response is a multipart message contains 3 part
all 3 parts are delimited by --Boundary
Multipart message
HTTP/1.1 200 OK
Server: IBM-HTTP-Server/1.0
Date: Mon, 25 Nov 2002 20:21:15 GMT
Connection: close
Accept-Ranges: bytes
Content-Type: multipart/mixed; boundary=BOUNDARY
Content-Length: 1251
--BOUNDARY
Content-type: text/html
Content-length: 138
part 1
text/html
part 2
application/x-ups-psmpld
part 3
application/x-ups-pld
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 103
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 758
000200000758300000640 KDGPLCR1 United Parcel Service11/25/02 Page:1 PLD Control Report 04:09 PM
--BOUNDARY-UPS | EUR Region EBSG
10
PLD0200 RESPONSE
text/html
Multipart message
HTTP/1.1 200 OK
Server: IBM-HTTP-Server/1.0
Date: Mon, 25 Nov 2002 20:21:15 GMT
Connection: close
Accept-Ranges: bytes
Content-Type: multipart/mixed; boundary=BOUNDARY
Content-Length: 1251
--BOUNDARY
Content-type: text/html
Content-length: 138
part 1
text/html
part 2
application/x-ups-psmpld
part 3
application/x-ups-pld
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 103
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 758
000200000758300000640 KDGPLCR1 United Parcel Service11/25/02 Page:1 PLD Control Report 04:09 PM
--BOUNDARY-UPS | EUR Region EBSG
11
PLD0200 RESPONSE
text/html
contains HTML formatted response
sample text/html part
Content-type: text/html
Content-length: 138
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
UPS | EUR Region EBSG
12
PLD0200 RESPONSE
application/x-ups-psmpld
Multipart message
HTTP/1.1 200 OK
Server: IBM-HTTP-Server/1.0
Date: Mon, 25 Nov 2002 20:21:15 GMT
Connection: close
Accept-Ranges: bytes
Content-Type: multipart/mixed; boundary=BOUNDARY
Content-Length: 1251
--BOUNDARY
Content-type: text/html
Content-length: 138
part 1
text/html
part 2
application/x-ups-psmpld
part 3
application/x-ups-pld
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 103
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 758
000200000758300000640 KDGPLCR1 United Parcel Service11/25/02 Page:1 PLD Control Report 04:09 PM
--BOUNDARY-UPS | EUR Region EBSG
13
PLD0200 RESPONSE
application/x-ups-psmpld
contains the response type (successful, warning, error or severe error).
4 Fields - delimited by "%“
Field1: UPSOnline
Field2: Version
Field3: PLD Upload - Return Codes
0000 Success
- Successful upload, no warning messages. Control and Status Reports are returned.
6930 PLD Warning - Successful upload with warning messages. Error, Control and Status Reports are returned.
6931 PLD Error
- Failed upload due to errors in the PLD data. Error and Status Reports are returned.
6932 PLD Severe Error - Failed upload due to errors in the input parameters. Status Report is returned.
Field4: PLD Upload - Message Text
ReasonCode(4digits) + Description (see PLD Documentation for more Details)
Sample successful upload
Content-type: application/x-ups-psmpld
Content-length: 103
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
Sample failed upload
Content-type: application/x-ups-psmpld
Content-length: 104
UPSOnLine%1.0%6931%5491PLD File contains Fatal Errors. Correct errors and resubmit.
UPS | EUR Region EBSG
14
PLD0200 RESPONSE
application/x-ups-pld
Multipart message
HTTP/1.1 200 OK
Server: IBM-HTTP-Server/1.0
Date: Mon, 25 Nov 2002 20:21:15 GMT
Connection: close
Accept-Ranges: bytes
Content-Type: multipart/mixed; boundary=BOUNDARY
Content-Length: 1251
--BOUNDARY
Content-type: text/html
Content-length: 138
part 1
text/html
part 2
application/x-ups-psmpld
part 3
application/x-ups-pld
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 103
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 758
000200000758300000640 KDGPLCR1 United Parcel Service11/25/02 Page:1 PLD Control Report 04:09 PM
--BOUNDARY-UPS | EUR Region EBSG
15
PLD0200 RESPONSE
application/x-ups-pld
contains the reports (Status, Error and Control Reports)
start with fixed length:
Pos. Length
Description
1
4
Number of Reports
5
8
Length of all Reporst
then start again with fixed length:
Pos. Length
Description
1
1
Type of Report
1=Status Report
2=Error Report
3=Control Report
2
8
Length of these Report (Xbyte)
9
Xbyte
Report
Sample
application/x-ups-pld part
Content-type: application/x-ups-pld
Content-length: 758
000200000758300000640 KDGPLCR1 United Parcel Service11/25/02 Pag
UPS | EUR Region EBSG
16
PLD0200 RESPONSE
application/x-ups-pld
Value
0002
00000746
Description
Number of Reports
Length of all Reports
Sample1:
application/x-ups-pld part
Content-type: application/x-ups-pld
Content-length: 759
000200000746300000640 KDGPLCR1
01/28/03 Page:1
United Parcel Service
PLD Control Report
08:12 AM
------------------------------------------------------------------------------ Pickup Date:20030203 S
equence#:000001111111002 #of Segments:000000000000000005
Shipper#:4334A4
Book/Page#:1111111002 Shipments:000
001 Packages:0000000001 10000008800000000Successful completion - No errors found.
Value
3
00000640
Description
3=Control Report
Length of Control Report
UPS | EUR Region EBSG
Value
1
00000088
Description
1=Status Report
Length of Control Report
17
PLD0200 RESPONSE
application/x-ups-pld
Value
0002
00001306
Description
Number of Reports
Length of all Reports
Sample2:
application/x-ups-pld part
Content-type: application/x-ups-pld
Content-length: 1319
000200001306200001200 KDGPLRS1
United Parcel Service
01/28/03
Host Access
08:28 AM
PLD Error Report
PAGE 1
------------------------------------------------------------------------------ Err
Error
Code/
Message/
Tracking
Seg
Field
Fiel
d
Number
ID
Name
Contents
------------------------------------------------------------------------------- 9124
Weight cannot be zero for a non-letter.
1Z4334A46800000016
*BA
ShipmentActualWeight
+0000000000000000
nd resubmit.
resubmit.
Value
1
00001200
5491 PLD File contains Fatal Errors. Correct errors a
10000008800025491PLD File contains Fatal Errors. Correct errors and
Description
2=Error Report
Length of Control Report
UPS | EUR Region EBSG
Value
1
00000088
Description
1=Status Report
Length of Control Report
18
PLD0200 RESPONSE
application/x-ups-pld
Status Report
contains a Return Code, a Reason Code and a Reason Text
fixed length:
Pos. Length
1
4
5
9
4
Xbyte
Description
Return Code
0000 - Successful Return Code No errors were found in the file.
0001 - Successful Warning Return Code Warning, non-fatal errors were found in the file
0002 - Unsuccessful Return Code Fatal errors were found in the file
0003 - Unsuccessful Return Code Severe errors were found
Reason Code (see SPF Documentation for more Details)
Reason Text (see SPF Documentation for more Details)
Status Report Sample 1
10000008800000000Successful completion - No errors found.
Status Report Sample 2
10000008800025491PLD File contains Fatal Errors. Correct errors and resubmit.
Status Report Sample 3
10000008800026504Password is invalid.
UPS | EUR Region EBSG
19
PLD0200 RESPONSE
application/x-ups-pld
Control Report
the length of this report is always X * 80 Byte
Insert a [CR] [LF] after each 80Bytes and you will get a well formed human readable report
Sample Error Report / unparsed
300000640 KDGPLCR1
United Parcel Service
01/28/03
Page:1
PLD Control Report
08:40 AM
------------------------------------------------------------------------------- Pickup
Date:20030203 Sequence#:000001111111002 #of Segments:000000000000000005
Shipper#:4334A4
Book/Page#:1111111002 Shipments:000001 Packages:0000000001
Sample Error Report / parsed
300000640
KDGPLCR1
Page:1
United Parcel Service
PLD Control Report
01/28/03
08:40 AM
------------------------------------------------------------------------------Pickup Date:20030203 Sequence#:000001111111002 #of Segments:000000000000000005
Shipper#:4334A4
Book/Page#:1111111002 Shipments:000001 Packages:0000000001
80
UPS | EUR Region EBSG
20
PLD0200 RESPONSE
application/x-ups-pld
Error Report
the length of this report is always X * 80 Byte
Inset a [CR] [LF] after each 80Bytes and you will get a well formed human readable report
Sample Error Report / unparsed
200001200 KDGPLRS1
United Parcel Service
01/28/03
Host Access
08:40 AM
PLD Error
Report
PAGE 1
------------------------------------------------------------------------------- Err
Error
Code/
Message/
Tracking
Seg
Field
Field
Number
ID
Name
Contents
------------------------------------------------------------------------------ 6715
Invalid 1z Service
Level for the chosen UPS services
1Z4334A45600000011
*PA
PackageTrackingNumber
1Z4334A45600000011
5481 PLD File submitted with above errors. Correct for next upload.
Sample Error Report / parsed
200001200
KDGPLRS1
United Parcel Service
Host Access
PLD Error Report
01/28/03
08:40 AM
PAGE 1
------------------------------------------------------------------------------Err
Error
Code/
Message/
Tracking
Seg
Field
Field
Number
ID
Name
Contents
------------------------------------------------------------------------------6715
Invalid 1z Service Level for the chosen UPS services
1Z4334A45600000011
*PA
PackageTrackingNumber
1Z4334A45600000011
5481
PLD File submitted with above errors. Correct for next upload.
80
UPS | EUR Region EBSG
21
PLD0200 RESPONSE
--BOUNDARY
Content-type: text/html
Content-length: 138
The Text
<HTML>
<HEAD>
<TITLE>UPS Internet Software</TITLE>
</HEAD>
<BODY>
<P>UPS Internet Software, Copyright UPS 1998</P>
</BODY>
</HTML>
--BOUNDARY
Content-type: application/x-ups-psmpld
Content-length: 104
The Response Type – 0000 Successful
UPSOnLine%1.0%0000%0000Successful completion - No errors found.
--BOUNDARY
Content-type: application/x-ups-pld
Content-length: 759
The Reports – 2 Reports ( Control + Status )
000200000746300000640 KDGPLCR1
United Parcel Service
01/28/03 Page:1
PLD Control Report
08:12
AM
------------------------------------------------------------------------------ Pickup
Date:20030203 Sequence#:000001111111002 #of Segments:000000000000000005
Shipper#:4334A4
Book/Page#:1111111002 Shipments:000001 Packages:0000000001
10000008800000000Successful completion - No errors found.
--BOUNDARY--
UPS | EUR Region EBSG
22
Thank you
© Copyright 2003 United Parcel Service of America, Inc. All rights reserved.