Android / Support API / Show Macro Replica
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
CkJsonObject queryParams = new CkJsonObject();
queryParams.UpdateString("macro_id","<integer>");
queryParams.UpdateString("ticket_id","<integer>");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros/new",queryParams);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// 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
String field;
String value;
String Title = jResp.stringOf("macro.title");
String Active = jResp.stringOf("macro.active");
String Created_at = jResp.stringOf("macro.created_at");
String Default = jResp.stringOf("macro.default");
String Description = jResp.stringOf("macro.description");
String Id = jResp.stringOf("macro.id");
String Position = jResp.stringOf("macro.position");
String Utc = jResp.stringOf("macro.restriction.utc");
String Sint_c = jResp.stringOf("macro.restriction.sint_c");
String Updated_at = jResp.stringOf("macro.updated_at");
String v_Url = jResp.stringOf("macro.url");
String App_installation = jResp.stringOf("macro.app_installation");
String Categories = jResp.stringOf("macro.categories");
String Permissions = jResp.stringOf("macro.permissions");
String Usage_1h = jResp.stringOf("macro.usage_1h");
String Usage_7d = jResp.stringOf("macro.usage_7d");
String Usage_24h = jResp.stringOf("macro.usage_24h");
String Usage_30d = jResp.stringOf("macro.usage_30d");
int i = 0;
int count_i = jResp.SizeOfArray("macro.actions");
while (i < count_i) {
jResp.put_I(i);
field = jResp.stringOf("macro.actions[i].field");
value = jResp.stringOf("macro.actions[i].value");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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}"
}
]
}
