Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "type": "Summary",
' "format": "JSON",
' "queryParameters": {
' "dateFrom": "2020-10-01T21:00:28.451Z",
' "dateTo": "2020-12-30T21:00:28.451Z",
' "statuses": [
' "Valid",
' "Cancelled",
' "Rejected"
' ],
' "productsInternalCodes": [
' ],
' "receiverSenderId": "",
' "receiverSenderType": "0",
' "branchNumber": "",
' "itemCodes": [
' {
' "codeValue": "",
' "codeType": ""
' }
' ],
' "documentTypeNames": [
' ]
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("type","Summary")
json.UpdateString("format","JSON")
json.UpdateString("queryParameters.dateFrom","2020-10-01T21:00:28.451Z")
json.UpdateString("queryParameters.dateTo","2020-12-30T21:00:28.451Z")
json.UpdateString("queryParameters.statuses[0]","Valid")
json.UpdateString("queryParameters.statuses[1]","Cancelled")
json.UpdateString("queryParameters.statuses[2]","Rejected")
json.UpdateNewArray("queryParameters.productsInternalCodes")
json.UpdateString("queryParameters.receiverSenderId","")
json.UpdateString("queryParameters.receiverSenderType","0")
json.UpdateString("queryParameters.branchNumber","")
json.UpdateString("queryParameters.itemCodes[0].codeValue","")
json.UpdateString("queryParameters.itemCodes[0].codeType","")
json.UpdateNewArray("queryParameters.documentTypeNames")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/api/v1/documentPackages/requests","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"type": "Summary",
"format": "JSON",
"queryParameters": {
"dateFrom": "2020-10-01T21:00:28.451Z",
"dateTo": "2020-12-30T21:00:28.451Z",
"statuses": [
"Valid",
"Cancelled",
"Rejected"
],
"productsInternalCodes": [],
"receiverSenderId": "",
"receiverSenderType": "0",
"branchNumber": "",
"itemCodes": [
{
"codeValue": "",
"codeType": ""
}
],
"documentTypeNames": []
}
}'
https://domain.com/api/v1/documentPackages/requests
Postman Collection Item JSON
{
"name": "5. Request Document Package",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{generatedAccessToken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"Summary\",\r\n \"format\": \"JSON\",\r\n \"queryParameters\": {\r\n \"dateFrom\": \"2020-10-01T21:00:28.451Z\",\r\n \"dateTo\": \"2020-12-30T21:00:28.451Z\",\r\n \"statuses\": [\r\n \"Valid\",\r\n \"Cancelled\",\r\n \"Rejected\"\r\n ],\r\n \"productsInternalCodes\": [],\r\n \"receiverSenderId\": \"\",\r\n \"receiverSenderType\": \"0\",\r\n \"branchNumber\": \"\",\r\n \"itemCodes\": [\r\n {\r\n \"codeValue\": \"\",\r\n \"codeType\": \"\"\r\n }\r\n ],\r\n \"documentTypeNames\": []\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiBaseUrl}}/api/v1/documentPackages/requests",
"host": [
"{{apiBaseUrl}}"
],
"path": [
"api",
"v1",
"documentPackages",
"requests"
]
}
},
"response": [
]
}