Chilkat Online Tools

C# / DHL Express APIs (MyDHL API) / Get Image

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "<Basic Auth Username>";
http.Password = "<Basic Auth Password>";

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("shipperAccountNumber","Ut aliqua");
queryParams.UpdateString("typeCode","customs-entry");
queryParams.UpdateString("pickupYearAndMonth","YYYY-MM");
queryParams.UpdateString("encodingFormat","tiff");
queryParams.UpdateString("allInOnePDF","false");
queryParams.UpdateString("compressedPackage","false");

http.SetRequestHeader("Webstore-Platform-Name","");
http.SetRequestHeader("Shipping-System-Platform-Name","");
http.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13");
http.SetRequestHeader("Plugin-Version","");
http.SetRequestHeader("Plugin-Name","");
http.SetRequestHeader("Shipping-System-Platform-Version","");
http.SetRequestHeader("Accept","application/json");
http.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT");
http.SetRequestHeader("Webstore-Platform-Version","");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/get-image",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "documents": [
//     {
//       "shipmentTrackingNumber": "1234567890",
//       "typeCode": "waybill",
//       "encodingFormat": "PDF",
//       "content": "base64 encoded document",
//       "function": "import"
//     },
//     {
//       "shipmentTrackingNumber": "1234567890",
//       "typeCode": "waybill",
//       "encodingFormat": "PDF",
//       "content": "base64 encoded document",
//       "function": "import"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

string shipmentTrackingNumber;
string typeCode;
string encodingFormat;
string content;
string v_function;

int i = 0;
int count_i = jResp.SizeOfArray("documents");
while (i < count_i) {
    jResp.I = i;
    shipmentTrackingNumber = jResp.StringOf("documents[i].shipmentTrackingNumber");
    typeCode = jResp.StringOf("documents[i].typeCode");
    encodingFormat = jResp.StringOf("documents[i].encodingFormat");
    content = jResp.StringOf("documents[i].content");
    v_function = jResp.StringOf("documents[i].function");
    i = i + 1;
}

Curl Command

curl -G -d "shipperAccountNumber=Ut%20aliqua"
	-d "typeCode=customs-entry"
	-d "pickupYearAndMonth=YYYY-MM"
	-d "encodingFormat=tiff"
	-d "allInOnePDF=false"
	-d "compressedPackage=false"
	-u '<Basic Auth Username>:<Basic Auth Password>'
	-H "Message-Reference: d0e7832e-5c98-11ea-bc55-0242ac13"
	-H "Message-Reference-Date: Wed, 21 Oct 2015 07:28:00 GMT"
	-H "Plugin-Name:  "
	-H "Plugin-Version:  "
	-H "Shipping-System-Platform-Name:  "
	-H "Shipping-System-Platform-Version:  "
	-H "Webstore-Platform-Name:  "
	-H "Webstore-Platform-Version:  "
	-H "Accept: application/json"
https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/get-image

Postman Collection Item JSON

{
  "name": "Get Image",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Please provide message reference\n",
        "key": "Message-Reference",
        "value": "d0e7832e-5c98-11ea-bc55-0242ac13"
      },
      {
        "description": "Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
        "key": "Message-Reference-Date",
        "value": "Wed, 21 Oct 2015 07:28:00 GMT"
      },
      {
        "description": "Please provide name of the plugin (applicable to 3PV only)\n",
        "key": "Plugin-Name",
        "value": " "
      },
      {
        "description": "Please provide version of the plugin (applicable to 3PV only)\n",
        "key": "Plugin-Version",
        "value": " "
      },
      {
        "description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
        "key": "Shipping-System-Platform-Name",
        "value": " "
      },
      {
        "description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
        "key": "Shipping-System-Platform-Version",
        "value": " "
      },
      {
        "description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
        "key": "Webstore-Platform-Name",
        "value": " "
      },
      {
        "description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
        "key": "Webstore-Platform-Version",
        "value": " "
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "shipments",
        ":shipmentTrackingNumber",
        "get-image"
      ],
      "query": [
        {
          "key": "shipperAccountNumber",
          "value": "Ut aliqua",
          "description": "(Required) DHL Express customer shipper account number"
        },
        {
          "key": "typeCode",
          "value": "customs-entry",
          "description": "(Required) Please provide correct document type."
        },
        {
          "key": "pickupYearAndMonth",
          "value": "YYYY-MM",
          "description": "(Required) Please provide the pickup's date in YYYY-MM format\n"
        },
        {
          "key": "encodingFormat",
          "value": "tiff",
          "description": "Please provide the document image encoding format in pdf or tiff format\n"
        },
        {
          "key": "allInOnePDF",
          "value": "false",
          "description": "Option to return all the document images in a single PDF file\n"
        },
        {
          "key": "compressedPackage",
          "value": "false",
          "description": "Option to return all the document images in a compressed package\n"
        }
      ],
      "variable": [
        {
          "key": "shipmentTrackingNumber",
          "value": "dolor veniam officia non",
          "description": "(Required) DHL Express shipment identification number"
        }
      ]
    },
    "description": "The Get Image service can be used to retrieve customer's own uploaded Commercial Invoice, Waybill Document  or supporting documents that uploaded during shipment creation. \n"
  },
  "response": [
    {
      "name": "Document Image found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          },
          {
            "description": "Please provide message reference\n",
            "key": "Message-Reference",
            "value": "d0e7832e-5c98-11ea-bc55-0242ac13"
          },
          {
            "description": "Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
            "key": "Message-Reference-Date",
            "value": "Wed, 21 Oct 2015 07:28:00 GMT"
          },
          {
            "description": "Please provide name of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Version",
            "value": " "
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shipments",
            ":shipmentTrackingNumber",
            "get-image"
          ],
          "query": [
            {
              "key": "shipperAccountNumber",
              "value": "Ut aliqua"
            },
            {
              "key": "typeCode",
              "value": "customs-entry"
            },
            {
              "key": "pickupYearAndMonth",
              "value": "YYYY-MM"
            },
            {
              "key": "encodingFormat",
              "value": "tiff"
            },
            {
              "key": "allInOnePDF",
              "value": "false"
            },
            {
              "key": "compressedPackage",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "shipmentTrackingNumber",
              "value": "dolor veniam officia non",
              "description": "(Required) DHL Express shipment identification number"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Invocation-Id",
          "value": "sed ut mollit",
          "description": "Unique identifier of the transaction"
        },
        {
          "key": "Message-Reference",
          "value": "sed ut mollit",
          "description": "Message reference provided by customer as part of reqeust or automatically generated when not provided"
        },
        {
          "key": "Content-Language",
          "value": "sed ut mollit",
          "description": ""
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"documents\": [\n    {\n      \"shipmentTrackingNumber\": \"1234567890\",\n      \"typeCode\": \"waybill\",\n      \"encodingFormat\": \"PDF\",\n      \"content\": \"base64 encoded document\",\n      \"function\": \"import\"\n    },\n    {\n      \"shipmentTrackingNumber\": \"1234567890\",\n      \"typeCode\": \"waybill\",\n      \"encodingFormat\": \"PDF\",\n      \"content\": \"base64 encoded document\",\n      \"function\": \"import\"\n    }\n  ]\n}"
    },
    {
      "name": "Wrong input parameters",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          },
          {
            "description": "Please provide message reference\n",
            "key": "Message-Reference",
            "value": "d0e7832e-5c98-11ea-bc55-0242ac13"
          },
          {
            "description": "Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
            "key": "Message-Reference-Date",
            "value": "Wed, 21 Oct 2015 07:28:00 GMT"
          },
          {
            "description": "Please provide name of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Version",
            "value": " "
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shipments",
            ":shipmentTrackingNumber",
            "get-image"
          ],
          "query": [
            {
              "key": "shipperAccountNumber",
              "value": "Ut aliqua"
            },
            {
              "key": "typeCode",
              "value": "customs-entry"
            },
            {
              "key": "pickupYearAndMonth",
              "value": "YYYY-MM"
            },
            {
              "key": "encodingFormat",
              "value": "tiff"
            },
            {
              "key": "allInOnePDF",
              "value": "false"
            },
            {
              "key": "compressedPackage",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "shipmentTrackingNumber",
              "value": "dolor veniam officia non",
              "description": "(Required) DHL Express shipment identification number"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"instance\": \"/expressapi/shipments/1371943801/get-image?shipperAccountNumber=848811505&typeCode=waybill&typeCode=commercial-invoice&pickupYearAndMonth=2021-11&encodingFormat=tiff&allInOnePDF=true&compressedPackage=false\",\n  \"detail\": \"1506: encodingFormat TIFF is not applicable in combination with allInOnePDF = true.  Please check the request message and retry.\",\n  \"title\": \"Bad request\",\n  \"message\": \"Bad request\",\n  \"status\": \"400\"\n}"
    },
    {
      "name": "No document image found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          },
          {
            "description": "Please provide message reference\n",
            "key": "Message-Reference",
            "value": "d0e7832e-5c98-11ea-bc55-0242ac13"
          },
          {
            "description": "Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
            "key": "Message-Reference-Date",
            "value": "Wed, 21 Oct 2015 07:28:00 GMT"
          },
          {
            "description": "Please provide name of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the plugin (applicable to 3PV only)\n",
            "key": "Plugin-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
            "key": "Shipping-System-Platform-Version",
            "value": " "
          },
          {
            "description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Name",
            "value": " "
          },
          {
            "description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
            "key": "Webstore-Platform-Version",
            "value": " "
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shipments",
            ":shipmentTrackingNumber",
            "get-image"
          ],
          "query": [
            {
              "key": "shipperAccountNumber",
              "value": "Ut aliqua"
            },
            {
              "key": "typeCode",
              "value": "customs-entry"
            },
            {
              "key": "pickupYearAndMonth",
              "value": "YYYY-MM"
            },
            {
              "key": "encodingFormat",
              "value": "tiff"
            },
            {
              "key": "allInOnePDF",
              "value": "false"
            },
            {
              "key": "compressedPackage",
              "value": "false"
            }
          ],
          "variable": [
            {
              "key": "shipmentTrackingNumber",
              "value": "dolor veniam officia non",
              "description": "(Required) DHL Express shipment identification number"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"instance\": \"/expressapi/shipments/1371943802/get-image?shipperAccountNumber=848811505&typeCode=waybills&pickupYearAndMonth=2021-11&encodingFormat=tiff&allInOnePDF=true&compressedPackage=false\",\n  \"detail\": \"1504: No document images found for the provided search criteria.\",\n  \"title\": \"Not found\",\n  \"message\": \"Not found\",\n  \"status\": \"404\"\n}"
    }
  ]
}