PureBasic / Support API / Update Macro
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
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "macro": {
; "title": "<string>",
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "active": "<boolean>",
; "description": "<string>",
; "restriction": {
; "id": "<integer>",
; "ids": [
; "<integer>",
; "<integer>"
; ],
; "type": "<string>",
; "dolore_dc": "velit irure",
; "ullamco368": 46888012
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"macro.title","<string>")
CkJsonObject::ckUpdateString(json,"macro.actions[0].field","<string>")
CkJsonObject::ckUpdateString(json,"macro.actions[0].value","<string>")
CkJsonObject::ckUpdateString(json,"macro.actions[1].field","<string>")
CkJsonObject::ckUpdateString(json,"macro.actions[1].value","<string>")
CkJsonObject::ckUpdateString(json,"macro.active","<boolean>")
CkJsonObject::ckUpdateString(json,"macro.description","<string>")
CkJsonObject::ckUpdateString(json,"macro.restriction.id","<integer>")
CkJsonObject::ckUpdateString(json,"macro.restriction.ids[0]","<integer>")
CkJsonObject::ckUpdateString(json,"macro.restriction.ids[1]","<integer>")
CkJsonObject::ckUpdateString(json,"macro.restriction.type","<string>")
CkJsonObject::ckUpdateString(json,"macro.restriction.dolore_dc","velit irure")
CkJsonObject::ckUpdateInt(json,"macro.restriction.ullamco368",46888012)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
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://example.zendesk.com/api/v2/macros/:macro_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)
; {
; "macro": {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "restriction": {
; "utc": -57663786.73485631,
; "sint_c": 56026975.00248328
; },
; "updated_at": "<dateTime>",
; "url": "<string>",
; "app_installation": "<string>",
; "categories": "<string>",
; "permissions": "<string>",
; "usage_1h": "<integer>",
; "usage_7d": "<integer>",
; "usage_24h": "<integer>",
; "usage_30d": "<integer>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
field.s
value.s
Title.s = CkJsonObject::ckStringOf(jResp,"macro.title")
Active.s = CkJsonObject::ckStringOf(jResp,"macro.active")
Created_at.s = CkJsonObject::ckStringOf(jResp,"macro.created_at")
Default.s = CkJsonObject::ckStringOf(jResp,"macro.default")
Description.s = CkJsonObject::ckStringOf(jResp,"macro.description")
Id.s = CkJsonObject::ckStringOf(jResp,"macro.id")
Position.s = CkJsonObject::ckStringOf(jResp,"macro.position")
Utc.s = CkJsonObject::ckStringOf(jResp,"macro.restriction.utc")
Sint_c.s = CkJsonObject::ckStringOf(jResp,"macro.restriction.sint_c")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"macro.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"macro.url")
App_installation.s = CkJsonObject::ckStringOf(jResp,"macro.app_installation")
Categories.s = CkJsonObject::ckStringOf(jResp,"macro.categories")
Permissions.s = CkJsonObject::ckStringOf(jResp,"macro.permissions")
Usage_1h.s = CkJsonObject::ckStringOf(jResp,"macro.usage_1h")
Usage_7d.s = CkJsonObject::ckStringOf(jResp,"macro.usage_7d")
Usage_24h.s = CkJsonObject::ckStringOf(jResp,"macro.usage_24h")
Usage_30d.s = CkJsonObject::ckStringOf(jResp,"macro.usage_30d")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"macro.actions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
field = CkJsonObject::ckStringOf(jResp,"macro.actions[i].field")
value = CkJsonObject::ckStringOf(jResp,"macro.actions[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"macro": {
"title": "<string>",
"actions": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"active": "<boolean>",
"description": "<string>",
"restriction": {
"id": "<integer>",
"ids": [
"<integer>",
"<integer>"
],
"type": "<string>",
"dolore_dc": "velit irure",
"ullamco368": 46888012
}
}
}'
https://example.zendesk.com/api/v2/macros/:macro_id
Postman Collection Item JSON
{
"name": "Update Macro",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macro\": {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"utc\": -57663786.73485631,\n \"sint_c\": 56026975.00248328\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n}"
}
]
}
