phpAx / Support API / Show Activity
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';
$http->SetRequestHeader('Accept','application/json');
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/activities/:activity_id',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "activity": {
// "actor": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "laborum485": "cupidatat occaecat sed esse deserunt",
// "incididuntfe4": "ut esse dolor dolore adipisicing",
// "ipsum_d": false,
// "non_4a": 96148739
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "aute_e0": false,
// "quis02": 59243202
// },
// "verified": "<boolean>"
// },
// "actor_id": "<integer>",
// "created_at": "<string>",
// "id": "<integer>",
// "object": {
// "consequatf61": 91186207,
// "labore__6": true
// },
// "target": {
// "anim_f0": 93298900,
// "deserunt_fb": -19031432.480811536
// },
// "title": "<string>",
// "updated_at": "<string>",
// "url": "<string>",
// "user": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "velit_d": false,
// "nulla68_": -89946385,
// "elit1": "id commodo cu"
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "dolor_c26": 36781242,
// "elit891": -33618800.11537988,
// "amet8": "consectetur"
// },
// "verified": "<boolean>"
// },
// "user_id": "<integer>",
// "verb": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Name = $jResp->stringOf('activity.actor.name');
$Active = $jResp->stringOf('activity.actor.active');
$Alias = $jResp->stringOf('activity.actor.alias');
$Chat_only = $jResp->stringOf('activity.actor.chat_only');
$Created_at = $jResp->stringOf('activity.actor.created_at');
$Custom_role_id = $jResp->stringOf('activity.actor.custom_role_id');
$Default_group_id = $jResp->stringOf('activity.actor.default_group_id');
$Details = $jResp->stringOf('activity.actor.details');
$v_Email = $jResp->stringOf('activity.actor.email');
$External_id = $jResp->stringOf('activity.actor.external_id');
$Iana_time_zone = $jResp->stringOf('activity.actor.iana_time_zone');
$Id = $jResp->stringOf('activity.actor.id');
$Last_login_at = $jResp->stringOf('activity.actor.last_login_at');
$Locale = $jResp->stringOf('activity.actor.locale');
$Locale_id = $jResp->stringOf('activity.actor.locale_id');
$Moderator = $jResp->stringOf('activity.actor.moderator');
$Notes = $jResp->stringOf('activity.actor.notes');
$Only_private_comments = $jResp->stringOf('activity.actor.only_private_comments');
$Organization_id = $jResp->stringOf('activity.actor.organization_id');
$Phone = $jResp->stringOf('activity.actor.phone');
$Laborum485 = $jResp->stringOf('activity.actor.photo.laborum485');
$Incididuntfe4 = $jResp->stringOf('activity.actor.photo.incididuntfe4');
$Ipsum_d = $jResp->BoolOf('activity.actor.photo.ipsum_d');
$Non_4a = $jResp->IntOf('activity.actor.photo.non_4a');
$Remote_photo_url = $jResp->stringOf('activity.actor.remote_photo_url');
$Report_csv = $jResp->stringOf('activity.actor.report_csv');
$Restricted_agent = $jResp->stringOf('activity.actor.restricted_agent');
$Role = $jResp->stringOf('activity.actor.role');
$Role_type = $jResp->stringOf('activity.actor.role_type');
$v_Shared = $jResp->stringOf('activity.actor.shared');
$Shared_agent = $jResp->stringOf('activity.actor.shared_agent');
$Shared_phone_number = $jResp->stringOf('activity.actor.shared_phone_number');
$Signature = $jResp->stringOf('activity.actor.signature');
$Suspended = $jResp->stringOf('activity.actor.suspended');
$Tags = $jResp->stringOf('activity.actor.tags');
$Ticket_restriction = $jResp->stringOf('activity.actor.ticket_restriction');
$Time_zone = $jResp->stringOf('activity.actor.time_zone');
$Two_factor_auth_enabled = $jResp->stringOf('activity.actor.two_factor_auth_enabled');
$Updated_at = $jResp->stringOf('activity.actor.updated_at');
$v_Url = $jResp->stringOf('activity.actor.url');
$Aute_e0 = $jResp->BoolOf('activity.actor.user_fields.aute_e0');
$Quis02 = $jResp->IntOf('activity.actor.user_fields.quis02');
$Verified = $jResp->stringOf('activity.actor.verified');
$Actor_id = $jResp->stringOf('activity.actor_id');
$activityCreated_at = $jResp->stringOf('activity.created_at');
$activityId = $jResp->stringOf('activity.id');
$Consequatf61 = $jResp->IntOf('activity.object.consequatf61');
$Labore__6 = $jResp->BoolOf('activity.object.labore__6');
$Anim_f0 = $jResp->IntOf('activity.target.anim_f0');
$Deserunt_fb = $jResp->stringOf('activity.target.deserunt_fb');
$Title = $jResp->stringOf('activity.title');
$activityUpdated_at = $jResp->stringOf('activity.updated_at');
$activityUrl = $jResp->stringOf('activity.url');
$UserName = $jResp->stringOf('activity.user.name');
$UserActive = $jResp->stringOf('activity.user.active');
$UserAlias = $jResp->stringOf('activity.user.alias');
$UserChat_only = $jResp->stringOf('activity.user.chat_only');
$UserCreated_at = $jResp->stringOf('activity.user.created_at');
$UserCustom_role_id = $jResp->stringOf('activity.user.custom_role_id');
$UserDefault_group_id = $jResp->stringOf('activity.user.default_group_id');
$UserDetails = $jResp->stringOf('activity.user.details');
$UserEmail = $jResp->stringOf('activity.user.email');
$UserExternal_id = $jResp->stringOf('activity.user.external_id');
$UserIana_time_zone = $jResp->stringOf('activity.user.iana_time_zone');
$UserId = $jResp->stringOf('activity.user.id');
$UserLast_login_at = $jResp->stringOf('activity.user.last_login_at');
$UserLocale = $jResp->stringOf('activity.user.locale');
$UserLocale_id = $jResp->stringOf('activity.user.locale_id');
$UserModerator = $jResp->stringOf('activity.user.moderator');
$UserNotes = $jResp->stringOf('activity.user.notes');
$UserOnly_private_comments = $jResp->stringOf('activity.user.only_private_comments');
$UserOrganization_id = $jResp->stringOf('activity.user.organization_id');
$UserPhone = $jResp->stringOf('activity.user.phone');
$Velit_d = $jResp->BoolOf('activity.user.photo.velit_d');
$Nulla68_ = $jResp->IntOf('activity.user.photo.nulla68_');
$Elit1 = $jResp->stringOf('activity.user.photo.elit1');
$UserRemote_photo_url = $jResp->stringOf('activity.user.remote_photo_url');
$UserReport_csv = $jResp->stringOf('activity.user.report_csv');
$UserRestricted_agent = $jResp->stringOf('activity.user.restricted_agent');
$UserRole = $jResp->stringOf('activity.user.role');
$UserRole_type = $jResp->stringOf('activity.user.role_type');
$UserShared = $jResp->stringOf('activity.user.shared');
$UserShared_agent = $jResp->stringOf('activity.user.shared_agent');
$UserShared_phone_number = $jResp->stringOf('activity.user.shared_phone_number');
$UserSignature = $jResp->stringOf('activity.user.signature');
$UserSuspended = $jResp->stringOf('activity.user.suspended');
$UserTags = $jResp->stringOf('activity.user.tags');
$UserTicket_restriction = $jResp->stringOf('activity.user.ticket_restriction');
$UserTime_zone = $jResp->stringOf('activity.user.time_zone');
$UserTwo_factor_auth_enabled = $jResp->stringOf('activity.user.two_factor_auth_enabled');
$UserUpdated_at = $jResp->stringOf('activity.user.updated_at');
$UserUrl = $jResp->stringOf('activity.user.url');
$Dolor_c26 = $jResp->IntOf('activity.user.user_fields.dolor_c26');
$Elit891 = $jResp->stringOf('activity.user.user_fields.elit891');
$Amet8 = $jResp->stringOf('activity.user.user_fields.amet8');
$UserVerified = $jResp->stringOf('activity.user.verified');
$User_id = $jResp->stringOf('activity.user_id');
$Verb = $jResp->stringOf('activity.verb');
?>
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/activities/:activity_id
Postman Collection Item JSON
{
"name": "Show Activity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/activities/:activity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"activities",
":activity_id"
],
"variable": [
{
"key": "activity_id",
"value": "<integer>"
}
]
},
"description": "Lists a specific activity.\n\n#### Allowed For\n\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/activities/:activity_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"activities",
":activity_id"
],
"variable": [
{
"key": "activity_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"activity\": {\n \"actor\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"laborum485\": \"cupidatat occaecat sed esse deserunt\",\n \"incididuntfe4\": \"ut esse dolor dolore adipisicing\",\n \"ipsum_d\": false,\n \"non_4a\": 96148739\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"aute_e0\": false,\n \"quis02\": 59243202\n },\n \"verified\": \"<boolean>\"\n },\n \"actor_id\": \"<integer>\",\n \"created_at\": \"<string>\",\n \"id\": \"<integer>\",\n \"object\": {\n \"consequatf61\": 91186207,\n \"labore__6\": true\n },\n \"target\": {\n \"anim_f0\": 93298900,\n \"deserunt_fb\": -19031432.480811536\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"velit_d\": false,\n \"nulla68_\": -89946385,\n \"elit1\": \"id commodo cu\"\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"dolor_c26\": 36781242,\n \"elit891\": -33618800.11537988,\n \"amet8\": \"consectetur\"\n },\n \"verified\": \"<boolean>\"\n },\n \"user_id\": \"<integer>\",\n \"verb\": \"<string>\"\n }\n}"
}
]
}
