Foxpro / Support API / Show Macro Replica
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcField
LOCAL lcValue
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcUtc
LOCAL lcSint_c
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL lcApp_installation
LOCAL lcCategories
LOCAL lcPermissions
LOCAL lcUsage_1h
LOCAL lcUsage_7d
LOCAL lcUsage_24h
LOCAL lcUsage_30d
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("macro_id","<integer>")
loQueryParams.UpdateString("ticket_id","<integer>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros/new",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcTitle = loJResp.StringOf("macro.title")
lcActive = loJResp.StringOf("macro.active")
lcCreated_at = loJResp.StringOf("macro.created_at")
lcDefault = loJResp.StringOf("macro.default")
lcDescription = loJResp.StringOf("macro.description")
lcId = loJResp.StringOf("macro.id")
lcPosition = loJResp.StringOf("macro.position")
lcUtc = loJResp.StringOf("macro.restriction.utc")
lcSint_c = loJResp.StringOf("macro.restriction.sint_c")
lcUpdated_at = loJResp.StringOf("macro.updated_at")
lcV_Url = loJResp.StringOf("macro.url")
lcApp_installation = loJResp.StringOf("macro.app_installation")
lcCategories = loJResp.StringOf("macro.categories")
lcPermissions = loJResp.StringOf("macro.permissions")
lcUsage_1h = loJResp.StringOf("macro.usage_1h")
lcUsage_7d = loJResp.StringOf("macro.usage_7d")
lcUsage_24h = loJResp.StringOf("macro.usage_24h")
lcUsage_30d = loJResp.StringOf("macro.usage_30d")
i = 0
lnCount_i = loJResp.SizeOfArray("macro.actions")
DO WHILE i < lnCount_i
loJResp.I = i
lcField = loJResp.StringOf("macro.actions[i].field")
lcValue = loJResp.StringOf("macro.actions[i].value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -G -d "macro_id=%3Cinteger%3E"
-d "ticket_id=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/new
Postman Collection Item JSON
{
"name": "Show Macro Replica",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/new?macro_id=<integer>&ticket_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"new"
],
"query": [
{
"key": "macro_id",
"value": "<integer>",
"description": "(Required) The ID of the macro to replicate"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket from which to build a macro replica"
}
]
},
"description": "Returns an unpersisted macro representation derived from a ticket or macro.\n\nThe endpoint takes one of the following query parameters: `macro_id` or `ticket_id`. If you include both, `macro_id` is used.\n\n#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/new?macro_id=<integer>&ticket_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"new"
],
"query": [
{
"key": "macro_id",
"value": "<integer>",
"description": "(Required) The ID of the macro to replicate"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket from which to build a macro replica"
}
]
}
},
"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}"
}
]
}
