Retrieve Pickup Request

General Operation Information

This web service operation lets Estes customers retrieve all information associated with an existing Estes pickup request via their unique pickup ID.

• Communication Pattern
• Preconditions
• Postconditions
• Input
• Output
• Errors & Exceptions

Communication Pattern

Request/Reply – This is a communication pattern where the service requester sends a request to the service provider. The service provider processes the request and returns a reply to the requester. This is an on-time operation, which means that there are no (long) time intervals between sending the request, processing of the request and transmitting the reply.

Preconditions

1. A requester must have a valid My Estes user account, and that account must have the appropriate privileges to call the pickup web service.
2. A valid pickup ID is required to identify the pickup information to update.

Postconditions

1. A general error is provided to indicate that the service failed from a system error.
2. The pickup request update was successful, with a message indicating success in the SOAP response.
3. Business validation errors are returned in a list citing a code and description for each.

Input

A valid request number is required.

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:est="https://estespickup.base.ws.provider.soapws.pickupRequest">
<soapenv:Header/>
	<soapenv:Body>
	    <est:getPickupRequestWS>
	        <requestNumber>?</requestNumber>
	    </est:getPickupRequestWS>
	</soapenv:Body>
</soapenv:Envelope>
			

Output

User authentication and authorization work the same for all web service operations. See Errors & Exceptions below for failures.

If retrieval of the pickup information was successful, a response containing the pickup request data will be returned. Below is a sample response to a pickup retrieval request with a valid pickup ID:

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ser-root:getPickupRequestWSResponse xmlns:ser-root="https://estespickup.base.ws.provider.soapws.pickupRequest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <pickupRequestWS>
            <requestNumber>49793</requestNumber>
            <shipper>
               <shipperName>A C GLASS CO</shipperName>
               <accountCode>0100800</accountCode>
               <shipperAddress>
                  <addressInfo>
                     <addressLine1>11112 WASHINGTON HWY</addressLine1>
                     <city>GLEN ALLEN</city>
                     <stateProvince>VA</stateProvince>
                     <postalCode>23058</postalCode>
                     <countryAbbrev xsi:nil="true"/>
                  </addressInfo>
               </shipperAddress>
            </shipper>
            <requestAction>LL</requestAction>
            <pickupDate>2013-10-02</pickupDate>
            <totalPieces>1200</totalPieces>
            <totalWeight>300</totalWeight>
            <hazmatFlag>N</hazmatFlag>
            <trailers>
               <trailer>
                  <trailerInfo>
                     <id>tlr01</id>
                     <length>53</length>
                     <type>SD</type>
                  </trailerInfo>
               </trailer>
            </trailers>
            <referenceNumbers>
               <referenceNumber>
                  <referenceInfo>
                     <type>REFNUM</type>
                     <value>custrefnum01</value>
                     <required/>
                  </referenceInfo>
               </referenceNumber>
            </referenceNumbers>
            <commodities>
               <commodity>
                  <id>17789</id>
                  <commodityInfo>
                     <code>MISC</code>
                     <packageCode>CN</packageCode>
                     <description>carton of misc stuff</description>
                     <hazmat>
                        <hazmatCode>UN</hazmatCode>
                        <hazmatFlag>H</hazmatFlag>
                     </hazmat>
                     <pieces>400</pieces>
                     <weight>600</weight>
                  </commodityInfo>
               </commodity>
            </commodities>
            <comments>
               <comment>
                  <id>171902</id>
                  <commentInfo>
                     <type>DNP</type>
                     <commentText>Pickup appointment date change from 2013-09-30 to 2013-10-02 due to Reason Code:  CR - Customer Request</commentText>
                  </commentInfo>
               </comment>
               <comment>
                  <id>171812</id>
                  <commentInfo>
                     <type>SSI</type>
                     <commentText>test SSI comment</commentText>
                  </commentInfo>
               </comment>
            </comments>
            <addresses>
               <address>
                  <id>46170</id>
                  <addressInfo>
                     <addressType>3</addressType>
                     <addressLine1>12 No Way</addressLine1>
                     <city>Richmond</city>
                     <stateProvince>VA</stateProvince>
                     <postalCode>23230</postalCode>
                     <countryAbbrev xsi:nil="true"/>
                  </addressInfo>
               </address>
            </addresses>
            <contacts>
               <contact>
                  <id>102760</id>
                  <contactInfo>
                     <contactType>3</contactType>
                     <name>
                        <firstName>Pat  Mann</firstName>
                     </name>
                     <email>pmann@example.com</email>
                     <phone>
                        <areaCode>804</areaCode>
                        <number>5551414</number>
                     </phone>
                     <receiveNotifications>N</receiveNotifications>
                     <notificationMethod>E</notificationMethod>
                  </contactInfo>
               </contact>
            </contacts>
         </pickupRequestWS>
      </ser-root:getPickupRequestWSResponse>
   </soapenv:Body>
</soapenv:Envelope>
			

Errors & Exceptions

The web service authorization will fail if the user is not authorized. Authentication will also fail if the username and password are not from a valid and active My Estes profile.

If a business validation rule is violated, an error code and description will be returned to the user in the following format:

<error>
    <elementName/>
    <code>PKE2050</code>
    <description>Shipper state must be a valid state abbreviation.</description>
    <badData></badData>
</error>
           

NOTE: Business validation error codes have three letters followed by four numbers.

Exceptions

Several error conditions will cause exceptions (faults) in the web service. You can view these error codes and their associated descriptions as a PDF or downloaded as a CSV.