Chilkat Online Tools

PureBasic / Egyptian eInvoicing SDK R1.5 / 5. Request Document Package

Back to Collection Items

IncludeFile "CkJsonObject.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

    ; 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": [
    ;     ]
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"type","Summary")
    CkJsonObject::ckUpdateString(json,"format","JSON")
    CkJsonObject::ckUpdateString(json,"queryParameters.dateFrom","2020-10-01T21:00:28.451Z")
    CkJsonObject::ckUpdateString(json,"queryParameters.dateTo","2020-12-30T21:00:28.451Z")
    CkJsonObject::ckUpdateString(json,"queryParameters.statuses[0]","Valid")
    CkJsonObject::ckUpdateString(json,"queryParameters.statuses[1]","Cancelled")
    CkJsonObject::ckUpdateString(json,"queryParameters.statuses[2]","Rejected")
    CkJsonObject::ckUpdateNewArray(json,"queryParameters.productsInternalCodes")
    CkJsonObject::ckUpdateString(json,"queryParameters.receiverSenderId","")
    CkJsonObject::ckUpdateString(json,"queryParameters.receiverSenderType","0")
    CkJsonObject::ckUpdateString(json,"queryParameters.branchNumber","")
    CkJsonObject::ckUpdateString(json,"queryParameters.itemCodes[0].codeValue","")
    CkJsonObject::ckUpdateString(json,"queryParameters.itemCodes[0].codeType","")
    CkJsonObject::ckUpdateNewArray(json,"queryParameters.documentTypeNames")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/documentPackages/requests","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": [
  ]
}