Foxpro / DHL Express APIs (MyDHL API) / Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcTypeCode
LOCAL j
LOCAL lnCount_j
LOCAL i
LOCAL lnCount_i
* 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')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "<Basic Auth Username>"
loHttp.Password = "<Basic Auth Password>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("accountNumber","Ut aliqua")
loQueryParams.UpdateString("type","SID")
loQueryParams.UpdateInt("size",1)
loHttp.SetRequestHeader("Webstore-Platform-Name","")
loHttp.SetRequestHeader("Shipping-System-Platform-Name","")
loHttp.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13")
loHttp.SetRequestHeader("Plugin-Version","")
loHttp.SetRequestHeader("Plugin-Name","")
loHttp.SetRequestHeader("Shipping-System-Platform-Version","")
loHttp.SetRequestHeader("Accept","application/json")
loHttp.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT")
loHttp.SetRequestHeader("Webstore-Platform-Version","")
loResp = loHttp.QuickRequestParams("GET","https://api-mock.dhl.com/mydhlapi/identifiers",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "warnings": [
* "Warning message if anything goes wrong",
* "Warning message if anything goes wrong"
* ],
* "identifiers": [
* {
* "typeCode": "SID",
* "list": [
* "1234567890"
* ]
* },
* {
* "typeCode": "SID",
* "list": [
* "1234567890"
* ]
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("warnings")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("warnings[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("identifiers")
DO WHILE i < lnCount_i
loJResp.I = i
lcTypeCode = loJResp.StringOf("identifiers[i].typeCode")
j = 0
lnCount_j = loJResp.SizeOfArray("identifiers[i].list")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("identifiers[i].list[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "accountNumber=Ut%20aliqua"
-d "type=SID"
-d "size=1"
-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/identifiers
Postman Collection Item JSON
{
"name": "Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments",
"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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua",
"description": "(Required) DHL Express customer account number"
},
{
"key": "type",
"value": "SID",
"description": "(Required) Type of DHL Express identifier to retrieve"
},
{
"key": "size",
"value": "1",
"description": "(Required) Number of identifiers to be retrieved"
}
]
},
"description": "Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments. Requires authorization to use this service from DHL Express.\n"
},
"response": [
{
"name": "Identifers provided",
"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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "type",
"value": "SID"
},
{
"key": "size",
"value": "1"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"warnings\": [\n \"Warning message if anything goes wrong\",\n \"Warning message if anything goes wrong\"\n ],\n \"identifiers\": [\n {\n \"typeCode\": \"SID\",\n \"list\": [\n \"1234567890\"\n ]\n },\n {\n \"typeCode\": \"SID\",\n \"list\": [\n \"1234567890\"\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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "type",
"value": "SID"
},
{
"key": "size",
"value": "1"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/identifiers\",\n \"detail\": \"3501: Request Identifier is not allowed for your username. Please contact your DHL Express representative.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
}
]
}
