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.UpdateString("type", value: "Summary")
json.UpdateString("format", value: "JSON")
json.UpdateString("queryParameters.dateFrom", value: "2020-10-01T21:00:28.451Z")
json.UpdateString("queryParameters.dateTo", value: "2020-12-30T21:00:28.451Z")
json.UpdateString("queryParameters.statuses[0]", value: "Valid")
json.UpdateString("queryParameters.statuses[1]", value: "Cancelled")
json.UpdateString("queryParameters.statuses[2]", value: "Rejected")
json.UpdateNewArray("queryParameters.productsInternalCodes")
json.UpdateString("queryParameters.receiverSenderId", value: "")
json.UpdateString("queryParameters.receiverSenderType", value: "0")
json.UpdateString("queryParameters.branchNumber", value: "")
json.UpdateString("queryParameters.itemCodes[0].codeValue", value: "")
json.UpdateString("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": [
]
}