EwsLabelService


Click here for a complete list of operations.

GetSCAN

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: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/GetSCAN"

<?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>
    <GetSCAN xmlns="www.envmgr.com/LabelService">
      <GetSCANRequest>
        <RequestID>string</RequestID>
        <GetSCANRequestParameters ImageResolution="string" ImageFormat="string" SubmissionID="string" CostCenter="string" FormType="string" ReferenceID="string" SearchZip="string" LabelSize="string">
          <FromName>string</FromName>
          <FromCompany>string</FromCompany>
          <FromAddress>string</FromAddress>
          <FromCity>string</FromCity>
          <FromState>string</FromState>
          <FromZip>string</FromZip>
        </GetSCANRequestParameters>
        <PicNumbers>
          <PicNumber>string</PicNumber>
          <PicNumber>string</PicNumber>
        </PicNumbers>
        <TransactionIds>
          <TransactionId>string</TransactionId>
          <TransactionId>string</TransactionId>
        </TransactionIds>
        <PieceNumbers>
          <PieceNumber>string</PieceNumber>
          <PieceNumber>string</PieceNumber>
        </PieceNumbers>
        <ManifestType>All or GlobalPost or None or USPS or GlobalAdvantage</ManifestType>
        <NumberOfContainerLabels>int</NumberOfContainerLabels>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </GetSCANRequest>
    </GetSCAN>
  </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>
    <GetSCANResponse xmlns="www.envmgr.com/LabelService">
      <GetSCANResponse>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <SubmissionID>string</SubmissionID>
        <SCANForm>string</SCANForm>
        <SubmissionIdOld>string</SubmissionIdOld>
        <ScanFormOld>string</ScanFormOld>
        <ExcludedItems>
          <Item>string</Item>
          <Item>string</Item>
        </ExcludedItems>
        <EndOfDayManifest>
          <ManifestType>All or GlobalPost or None or USPS or GlobalAdvantage</ManifestType>
          <PickUpCarrier>string</PickUpCarrier>
          <ManifestID>int</ManifestID>
          <ManifestUrl>string</ManifestUrl>
          <ContainerLabels>
            <ContainerLabel xsi:nil="true" />
            <ContainerLabel xsi:nil="true" />
          </ContainerLabels>
        </EndOfDayManifest>
        <AdditionalScanForms>
          <Form>string</Form>
          <Form>string</Form>
        </AdditionalScanForms>
      </GetSCANResponse>
    </GetSCANResponse>
  </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: labelserver.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>
    <GetSCAN xmlns="www.envmgr.com/LabelService">
      <GetSCANRequest>
        <RequestID>string</RequestID>
        <GetSCANRequestParameters ImageResolution="string" ImageFormat="string" SubmissionID="string" CostCenter="string" FormType="string" ReferenceID="string" SearchZip="string" LabelSize="string">
          <FromName>string</FromName>
          <FromCompany>string</FromCompany>
          <FromAddress>string</FromAddress>
          <FromCity>string</FromCity>
          <FromState>string</FromState>
          <FromZip>string</FromZip>
        </GetSCANRequestParameters>
        <PicNumbers>
          <PicNumber>string</PicNumber>
          <PicNumber>string</PicNumber>
        </PicNumbers>
        <TransactionIds>
          <TransactionId>string</TransactionId>
          <TransactionId>string</TransactionId>
        </TransactionIds>
        <PieceNumbers>
          <PieceNumber>string</PieceNumber>
          <PieceNumber>string</PieceNumber>
        </PieceNumbers>
        <ManifestType>All or GlobalPost or None or USPS or GlobalAdvantage</ManifestType>
        <NumberOfContainerLabels>int</NumberOfContainerLabels>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </GetSCANRequest>
    </GetSCAN>
  </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>
    <GetSCANResponse xmlns="www.envmgr.com/LabelService">
      <GetSCANResponse>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <SubmissionID>string</SubmissionID>
        <SCANForm>string</SCANForm>
        <SubmissionIdOld>string</SubmissionIdOld>
        <ScanFormOld>string</ScanFormOld>
        <ExcludedItems>
          <Item>string</Item>
          <Item>string</Item>
        </ExcludedItems>
        <EndOfDayManifest>
          <ManifestType>All or GlobalPost or None or USPS or GlobalAdvantage</ManifestType>
          <PickUpCarrier>string</PickUpCarrier>
          <ManifestID>int</ManifestID>
          <ManifestUrl>string</ManifestUrl>
          <ContainerLabels>
            <ContainerLabel xsi:nil="true" />
            <ContainerLabel xsi:nil="true" />
          </ContainerLabels>
        </EndOfDayManifest>
        <AdditionalScanForms>
          <Form>string</Form>
          <Form>string</Form>
        </AdditionalScanForms>
      </GetSCANResponse>
    </GetSCANResponse>
  </soap12:Body>
</soap12:Envelope>