Chilkat Online Tools

C / DHL Express APIs (MyDHL API) / Validate DHL Express pickup/delivery capabilities at origin/destination

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *strVal;
    const char *countryCode;
    const char *postalCode;
    const char *cityName;
    const char *countyName;
    const char *Code;
    const char *Description;
    const char *GMTOffset;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"<Basic Auth Username>");
    CkHttp_putPassword(http,"<Basic Auth Password>");

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"type","pickup");
    CkJsonObject_UpdateString(queryParams,"countryCode","CZ");
    CkJsonObject_UpdateInt(queryParams,"postalCode",14800);
    CkJsonObject_UpdateString(queryParams,"cityName","Prague");
    CkJsonObject_UpdateString(queryParams,"countyName","praha");
    CkJsonObject_UpdateString(queryParams,"strictValidation","true");

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://api-mock.dhl.com/mydhlapi/address-validate",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

    // {
    //   "warnings": [
    //     "ea quis cillum ut",
    //     "amet voluptate dol"
    //   ],
    //   "address": [
    //     {
    //       "countryCode": "CZ",
    //       "postalCode": "14800",
    //       "cityName": "PRAGUE",
    //       "countyName": "ex id labore aute",
    //       "serviceArea": {
    //         "code": "PRG",
    //         "description": "PRAGUE-CZECH REPUBLIC, THE",
    //         "GMTOffset": "+01:00"
    //       }
    //     },
    //     {
    //       "countryCode": "CZ",
    //       "postalCode": "14800",
    //       "cityName": "PRAGUE",
    //       "countyName": "quis ullamco reprehenderit esse in",
    //       "serviceArea": {
    //         "code": "PRG",
    //         "description": "PRAGUE-CZECH REPUBLIC, THE",
    //         "GMTOffset": "+01:00"
    //       }
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"warnings");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"warnings[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"address");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        countryCode = CkJsonObject_stringOf(jResp,"address[i].countryCode");
        postalCode = CkJsonObject_stringOf(jResp,"address[i].postalCode");
        cityName = CkJsonObject_stringOf(jResp,"address[i].cityName");
        countyName = CkJsonObject_stringOf(jResp,"address[i].countyName");
        Code = CkJsonObject_stringOf(jResp,"address[i].serviceArea.code");
        Description = CkJsonObject_stringOf(jResp,"address[i].serviceArea.description");
        GMTOffset = CkJsonObject_stringOf(jResp,"address[i].serviceArea.GMTOffset");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -G -d "type=pickup"
	-d "countryCode=CZ"
	-d "postalCode=14800"
	-d "cityName=Prague"
	-d "countyName=praha"
	-d "strictValidation=true"
	-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/address-validate

Postman Collection Item JSON

{
  "name": "Validate DHL Express pickup/delivery capabilities at origin/destination",
  "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}}/address-validate?type=pickup&countryCode=CZ&postalCode=14800&cityName=Prague&countyName=praha&strictValidation=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "address-validate"
      ],
      "query": [
        {
          "key": "type",
          "value": "pickup",
          "description": "(Required) "
        },
        {
          "key": "countryCode",
          "value": "CZ",
          "description": "(Required) A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code"
        },
        {
          "key": "postalCode",
          "value": "14800",
          "description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode"
        },
        {
          "key": "cityName",
          "value": "Prague",
          "description": "Text specifying the city name"
        },
        {
          "key": "countyName",
          "value": "praha",
          "description": "Text specifying the county name"
        },
        {
          "key": "strictValidation",
          "value": "true",
          "description": "If set to true service will return no records when exact valid match not found"
        }
      ]
    },
    "description": "Validates if DHL Express has got pickup/delivery capabilities at origin/destination\n"
  },
  "response": [
    {
      "name": "Address validated",
      "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}}/address-validate?type=pickup&countryCode=CZ&postalCode=14800&cityName=Prague&countyName=praha&strictValidation=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "address-validate"
          ],
          "query": [
            {
              "key": "type",
              "value": "pickup"
            },
            {
              "key": "countryCode",
              "value": "CZ"
            },
            {
              "key": "postalCode",
              "value": "14800"
            },
            {
              "key": "cityName",
              "value": "Prague"
            },
            {
              "key": "countyName",
              "value": "praha"
            },
            {
              "key": "strictValidation",
              "value": "true"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"warnings\": [\n    \"ea quis cillum ut\",\n    \"amet voluptate dol\"\n  ],\n  \"address\": [\n    {\n      \"countryCode\": \"CZ\",\n      \"postalCode\": \"14800\",\n      \"cityName\": \"PRAGUE\",\n      \"countyName\": \"ex id labore aute\",\n      \"serviceArea\": {\n        \"code\": \"PRG\",\n        \"description\": \"PRAGUE-CZECH REPUBLIC, THE\",\n        \"GMTOffset\": \"+01:00\"\n      }\n    },\n    {\n      \"countryCode\": \"CZ\",\n      \"postalCode\": \"14800\",\n      \"cityName\": \"PRAGUE\",\n      \"countyName\": \"quis ullamco reprehenderit esse in\",\n      \"serviceArea\": {\n        \"code\": \"PRG\",\n        \"description\": \"PRAGUE-CZECH REPUBLIC, THE\",\n        \"GMTOffset\": \"+01:00\"\n      }\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}}/address-validate?type=pickup&countryCode=CZ&postalCode=14800&cityName=Prague&countyName=praha&strictValidation=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "address-validate"
          ],
          "query": [
            {
              "key": "type",
              "value": "pickup"
            },
            {
              "key": "countryCode",
              "value": "CZ"
            },
            {
              "key": "postalCode",
              "value": "14800"
            },
            {
              "key": "cityName",
              "value": "Prague"
            },
            {
              "key": "countyName",
              "value": "praha"
            },
            {
              "key": "strictValidation",
              "value": "true"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"instance\": \"/expressapi/address-validate\",\n  \"detail\": \"Parameters not having correct format: cityName (maxLength=45)\",\n  \"title\": \"Bad request\",\n  \"message\": \"Bad request\",\n  \"status\": \"400\"\n}"
    }
  ]
}