EwsLabelService


Click here for a complete list of operations.

GetPackagePickupAvailability

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: elstestserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/GetPackagePickupAvailability"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPackagePickupAvailability xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityRequest>
        <RequestID>string</RequestID>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Email>string</Email>
        </PhysicalPickupAddress>
        <Carrier>string</Carrier>
        <PickupDate>dateTime</PickupDate>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </PackagePickupAvailabilityRequest>
    </GetPackagePickupAvailability>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPackagePickupAvailabilityResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <PackagePickup>
          <DayOfWeek>string</DayOfWeek>
          <Date>string</Date>
          <CarrierRoute>string</CarrierRoute>
          <PickupTimeEarliest>string</PickupTimeEarliest>
          <PickupTimeLatest>string</PickupTimeLatest>
        </PackagePickup>
        <EstimatedAmount>decimal</EstimatedAmount>
      </PackagePickupAvailabilityResponse>
    </GetPackagePickupAvailabilityResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: elstestserver.endicia.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPackagePickupAvailability xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityRequest>
        <RequestID>string</RequestID>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Email>string</Email>
        </PhysicalPickupAddress>
        <Carrier>string</Carrier>
        <PickupDate>dateTime</PickupDate>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </PackagePickupAvailabilityRequest>
    </GetPackagePickupAvailability>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPackagePickupAvailabilityResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <PackagePickup>
          <DayOfWeek>string</DayOfWeek>
          <Date>string</Date>
          <CarrierRoute>string</CarrierRoute>
          <PickupTimeEarliest>string</PickupTimeEarliest>
          <PickupTimeLatest>string</PickupTimeLatest>
        </PackagePickup>
        <EstimatedAmount>decimal</EstimatedAmount>
      </PackagePickupAvailabilityResponse>
    </GetPackagePickupAvailabilityResponse>
  </soap12:Body>
</soap12:Envelope>