Document Images Web Service

A. Duie Pyle provides document image retrieval as an XML document. Any customer with a MyPyle login may obtain one or more document images by sending a specially formatted URL and receive the Base 64 encoded images in an XML document.

Request

GET
/publicdocs/DocImages_XML
https://www.aduiepyle.com/publicdocs/DocImages_XML
  ?MyPyleID=MyPyleID
  &Pro=pro-list
  &DocTypes=doc-type-list

Parameters

  • Name
    MyPyleID
    Type
    string
    Description

    This parameter contains your MyPyle login which is normally your E-mail address. Example: ?MyPyleID=duie@aduiepyle.com

  • Name
    Pro
    Type
    string
    Description

    This required parameter contains one or more comma separated Pyle Pro Numbers. Examples: &pro=99999999 &pro=157215096,157215237

  • Name
    DocTypes
    Type
    string
    Description

    This optional parameter contains the desired document types. The default is BL (Bill of Lading) and DR (Delivery Receipt). You may also use WC to obtain Weight Certificates, RC for Research Certificates and WS for Partner Weight/Research Certificates. Examples: &doctypes=BL – only request Bill of Lading &doctypes=BL,DR,WC,RC,WS – request all document types

Examples

The following example will request Bill of Lading and Delivery Receipt images for pro number 99999999.

Request

https://www.aduiepyle.com/Publicdocs/DocImages_XML?MyPyleID=duie@aduiepyle.com&pro=99999999

This example will request Bill of Lading, Delivery Receipt and Weight Certificate images for pro numbers 157215096 and 157215237.

Request

https://www.aduiepyle.com/Publicdocs/DocImages_XML?MyPyleID=duie@aduiepyle.com&pro=157215096,157215237&doctypes=BL,DR,WC&json=1

Sample Document Images

{
  "DocImages": [
    {
      "type": "Bill of Lading",
      "pro": "157215096",
      "fileExt": "tif",
      "base64Image": " … … … "
    },
    {
      "type": "Bill of Lading",
      "pro": "157215237",
      "fileExt": "tif",
      "base64Image": " … … … "
    }
  ],
  "querydatetime": "2021-01-13T11:06:53.6710313-05:00"
}

Please note that EDI Services and Web Services are not available between 12 Midnight and 12:15 AM Eastern Time during our server maintenance window.

All customers using the Web Services should sign up for Web Services Notification to be informed whenever one of the Web Service interfaces is updated.

Revision 3 – 1/13/2021