Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.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.
; {
; "name": "<string>",
; "status": "PROCESSING",
; "category": null,
; "category_custom": null,
; "created_at": "<dateTime>",
; "customer_id": null,
; "description": null,
; "document_id": null,
; "end_at": "<dateTime>",
; "finish_at": "<dateTime>",
; "id": "<long>",
; "login_id": "<long>",
; "position_id": null,
; "priority": "NORMAL",
; "project_id": null,
; "start_at": null,
; "status_percent": null
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"name","<string>")
CkJsonObject::ckUpdateString(json,"status","PROCESSING")
CkJsonObject::ckUpdateNull(json,"category")
CkJsonObject::ckUpdateNull(json,"category_custom")
CkJsonObject::ckUpdateString(json,"created_at","<dateTime>")
CkJsonObject::ckUpdateNull(json,"customer_id")
CkJsonObject::ckUpdateNull(json,"description")
CkJsonObject::ckUpdateNull(json,"document_id")
CkJsonObject::ckUpdateString(json,"end_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"finish_at","<dateTime>")
CkJsonObject::ckUpdateString(json,"id","<long>")
CkJsonObject::ckUpdateString(json,"login_id","<long>")
CkJsonObject::ckUpdateNull(json,"position_id")
CkJsonObject::ckUpdateString(json,"priority","NORMAL")
CkJsonObject::ckUpdateNull(json,"project_id")
CkJsonObject::ckUpdateNull(json,"start_at")
CkJsonObject::ckUpdateNull(json,"status_percent")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.easybill.de/rest/v1/tasks/:id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "name": "<string>",
; "status": "PROCESSING",
; "category": null,
; "category_custom": null,
; "created_at": "<dateTime>",
; "customer_id": null,
; "description": null,
; "document_id": null,
; "end_at": "<dateTime>",
; "finish_at": "<dateTime>",
; "id": "<long>",
; "login_id": "<long>",
; "position_id": null,
; "priority": "NORMAL",
; "project_id": null,
; "start_at": null,
; "status_percent": null
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name.s = CkJsonObject::ckStringOf(jResp,"name")
status.s = CkJsonObject::ckStringOf(jResp,"status")
category.s = CkJsonObject::ckStringOf(jResp,"category")
category_custom.s = CkJsonObject::ckStringOf(jResp,"category_custom")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
customer_id.s = CkJsonObject::ckStringOf(jResp,"customer_id")
description.s = CkJsonObject::ckStringOf(jResp,"description")
document_id.s = CkJsonObject::ckStringOf(jResp,"document_id")
end_at.s = CkJsonObject::ckStringOf(jResp,"end_at")
finish_at.s = CkJsonObject::ckStringOf(jResp,"finish_at")
id.s = CkJsonObject::ckStringOf(jResp,"id")
login_id.s = CkJsonObject::ckStringOf(jResp,"login_id")
position_id.s = CkJsonObject::ckStringOf(jResp,"position_id")
priority.s = CkJsonObject::ckStringOf(jResp,"priority")
project_id.s = CkJsonObject::ckStringOf(jResp,"project_id")
start_at.s = CkJsonObject::ckStringOf(jResp,"start_at")
status_percent.s = CkJsonObject::ckStringOf(jResp,"status_percent")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"name": "<string>",
"status": "PROCESSING",
"category": null,
"category_custom": null,
"created_at": "<dateTime>",
"customer_id": null,
"description": null,
"document_id": null,
"end_at": "<dateTime>",
"finish_at": "<dateTime>",
"id": "<long>",
"login_id": "<long>",
"position_id": null,
"priority": "NORMAL",
"project_id": null,
"start_at": null,
"status_percent": null
}'
https://api.easybill.de/rest/v1/tasks/:id
Postman Collection Item JSON
{
"name": "Update task",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of task"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\n}"
},
{
"name": "Invalid task",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
