Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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": [
; ]
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("type","Summary")
$oJson.UpdateString("format","JSON")
$oJson.UpdateString("queryParameters.dateFrom","2020-10-01T21:00:28.451Z")
$oJson.UpdateString("queryParameters.dateTo","2020-12-30T21:00:28.451Z")
$oJson.UpdateString("queryParameters.statuses[0]","Valid")
$oJson.UpdateString("queryParameters.statuses[1]","Cancelled")
$oJson.UpdateString("queryParameters.statuses[2]","Rejected")
$oJson.UpdateNewArray("queryParameters.productsInternalCodes")
$oJson.UpdateString("queryParameters.receiverSenderId","")
$oJson.UpdateString("queryParameters.receiverSenderType","0")
$oJson.UpdateString("queryParameters.branchNumber","")
$oJson.UpdateString("queryParameters.itemCodes[0].codeValue","")
$oJson.UpdateString("queryParameters.itemCodes[0].codeType","")
$oJson.UpdateNewArray("queryParameters.documentTypeNames")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://domain.com/api/v1/documentPackages/requests","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)
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": [
]
}