PureBasic / DHL Express APIs (MyDHL API) / Validate DHL Express pickup/delivery capabilities at origin/destination
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "<Basic Auth Username>")
CkHttp::setCkPassword(http, "<Basic Auth Password>")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"type","pickup")
CkJsonObject::ckUpdateString(queryParams,"countryCode","CZ")
CkJsonObject::ckUpdateInt(queryParams,"postalCode",14800)
CkJsonObject::ckUpdateString(queryParams,"cityName","Prague")
CkJsonObject::ckUpdateString(queryParams,"countyName","praha")
CkJsonObject::ckUpdateString(queryParams,"strictValidation","true")
CkHttp::ckSetRequestHeader(http,"Webstore-Platform-Name","")
CkHttp::ckSetRequestHeader(http,"Shipping-System-Platform-Name","")
CkHttp::ckSetRequestHeader(http,"Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13")
CkHttp::ckSetRequestHeader(http,"Plugin-Version","")
CkHttp::ckSetRequestHeader(http,"Plugin-Name","")
CkHttp::ckSetRequestHeader(http,"Shipping-System-Platform-Version","")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
CkHttp::ckSetRequestHeader(http,"Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT")
CkHttp::ckSetRequestHeader(http,"Webstore-Platform-Version","")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api-mock.dhl.com/mydhlapi/address-validate",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
strVal.s
countryCode.s
postalCode.s
cityName.s
countyName.s
Code.s
Description.s
GMTOffset.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"warnings")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"warnings[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"address")
While i < count_i
CkJsonObject::setCkI(jResp, i)
countryCode = CkJsonObject::ckStringOf(jResp,"address[i].countryCode")
postalCode = CkJsonObject::ckStringOf(jResp,"address[i].postalCode")
cityName = CkJsonObject::ckStringOf(jResp,"address[i].cityName")
countyName = CkJsonObject::ckStringOf(jResp,"address[i].countyName")
Code = CkJsonObject::ckStringOf(jResp,"address[i].serviceArea.code")
Description = CkJsonObject::ckStringOf(jResp,"address[i].serviceArea.description")
GMTOffset = CkJsonObject::ckStringOf(jResp,"address[i].serviceArea.GMTOffset")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}