VBScript / DHL Express APIs (MyDHL API) / Validate DHL Express pickup/delivery capabilities at origin/destination
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "<Basic Auth Username>"
http.Password = "<Basic Auth Password>"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("type","pickup")
success = queryParams.UpdateString("countryCode","CZ")
success = queryParams.UpdateInt("postalCode",14800)
success = queryParams.UpdateString("cityName","Prague")
success = queryParams.UpdateString("countyName","praha")
success = queryParams.UpdateString("strictValidation","true")
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",""
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://api-mock.dhl.com/mydhlapi/address-validate",queryParams)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(resp.Header)
outFile.WriteLine("Failed.")
WScript.Quit
End If
' 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
i = 0
count_i = jResp.SizeOfArray("warnings")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("warnings[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("address")
Do While i < count_i
jResp.I = i
countryCode = jResp.StringOf("address[i].countryCode")
postalCode = jResp.StringOf("address[i].postalCode")
cityName = jResp.StringOf("address[i].cityName")
countyName = jResp.StringOf("address[i].countyName")
Code = jResp.StringOf("address[i].serviceArea.code")
Description = jResp.StringOf("address[i].serviceArea.description")
GMTOffset = jResp.StringOf("address[i].serviceArea.GMTOffset")
i = i + 1
Loop
outFile.Close
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}"
}
]
}
