Chilkat Online Tools

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

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

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

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

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"

    var resp: CkoHttpResponse? = http.postJson3("https://domain.com/api/v1/documentPackages/requests", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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