Chilkat Online Tools

lianja / Support API / Show Activity

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/activities/:activity_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

lcName = loJResp.StringOf("activity.actor.name")
lcActive = loJResp.StringOf("activity.actor.active")
lcAlias = loJResp.StringOf("activity.actor.alias")
lcChat_only = loJResp.StringOf("activity.actor.chat_only")
lcCreated_at = loJResp.StringOf("activity.actor.created_at")
lcCustom_role_id = loJResp.StringOf("activity.actor.custom_role_id")
lcDefault_group_id = loJResp.StringOf("activity.actor.default_group_id")
lcDetails = loJResp.StringOf("activity.actor.details")
lcV_Email = loJResp.StringOf("activity.actor.email")
lcExternal_id = loJResp.StringOf("activity.actor.external_id")
lcIana_time_zone = loJResp.StringOf("activity.actor.iana_time_zone")
lcId = loJResp.StringOf("activity.actor.id")
lcLast_login_at = loJResp.StringOf("activity.actor.last_login_at")
lcLocale = loJResp.StringOf("activity.actor.locale")
lcLocale_id = loJResp.StringOf("activity.actor.locale_id")
lcModerator = loJResp.StringOf("activity.actor.moderator")
lcNotes = loJResp.StringOf("activity.actor.notes")
lcOnly_private_comments = loJResp.StringOf("activity.actor.only_private_comments")
lcOrganization_id = loJResp.StringOf("activity.actor.organization_id")
lcPhone = loJResp.StringOf("activity.actor.phone")
lcLaborum485 = loJResp.StringOf("activity.actor.photo.laborum485")
lcIncididuntfe4 = loJResp.StringOf("activity.actor.photo.incididuntfe4")
llIpsum_d = loJResp.BoolOf("activity.actor.photo.ipsum_d")
lnNon_4a = loJResp.IntOf("activity.actor.photo.non_4a")
lcRemote_photo_url = loJResp.StringOf("activity.actor.remote_photo_url")
lcReport_csv = loJResp.StringOf("activity.actor.report_csv")
lcRestricted_agent = loJResp.StringOf("activity.actor.restricted_agent")
lcRole = loJResp.StringOf("activity.actor.role")
lcRole_type = loJResp.StringOf("activity.actor.role_type")
lcV_Shared = loJResp.StringOf("activity.actor.shared")
lcShared_agent = loJResp.StringOf("activity.actor.shared_agent")
lcShared_phone_number = loJResp.StringOf("activity.actor.shared_phone_number")
lcSignature = loJResp.StringOf("activity.actor.signature")
lcSuspended = loJResp.StringOf("activity.actor.suspended")
lcTags = loJResp.StringOf("activity.actor.tags")
lcTicket_restriction = loJResp.StringOf("activity.actor.ticket_restriction")
lcTime_zone = loJResp.StringOf("activity.actor.time_zone")
lcTwo_factor_auth_enabled = loJResp.StringOf("activity.actor.two_factor_auth_enabled")
lcUpdated_at = loJResp.StringOf("activity.actor.updated_at")
lcV_Url = loJResp.StringOf("activity.actor.url")
llAute_e0 = loJResp.BoolOf("activity.actor.user_fields.aute_e0")
lnQuis02 = loJResp.IntOf("activity.actor.user_fields.quis02")
lcVerified = loJResp.StringOf("activity.actor.verified")
lcActor_id = loJResp.StringOf("activity.actor_id")
lcActivityCreated_at = loJResp.StringOf("activity.created_at")
lcActivityId = loJResp.StringOf("activity.id")
lnConsequatf61 = loJResp.IntOf("activity.object.consequatf61")
llLabore__6 = loJResp.BoolOf("activity.object.labore__6")
lnAnim_f0 = loJResp.IntOf("activity.target.anim_f0")
lcDeserunt_fb = loJResp.StringOf("activity.target.deserunt_fb")
lcTitle = loJResp.StringOf("activity.title")
lcActivityUpdated_at = loJResp.StringOf("activity.updated_at")
lcActivityUrl = loJResp.StringOf("activity.url")
lcUserName = loJResp.StringOf("activity.user.name")
lcUserActive = loJResp.StringOf("activity.user.active")
lcUserAlias = loJResp.StringOf("activity.user.alias")
lcUserChat_only = loJResp.StringOf("activity.user.chat_only")
lcUserCreated_at = loJResp.StringOf("activity.user.created_at")
lcUserCustom_role_id = loJResp.StringOf("activity.user.custom_role_id")
lcUserDefault_group_id = loJResp.StringOf("activity.user.default_group_id")
lcUserDetails = loJResp.StringOf("activity.user.details")
lcUserEmail = loJResp.StringOf("activity.user.email")
lcUserExternal_id = loJResp.StringOf("activity.user.external_id")
lcUserIana_time_zone = loJResp.StringOf("activity.user.iana_time_zone")
lcUserId = loJResp.StringOf("activity.user.id")
lcUserLast_login_at = loJResp.StringOf("activity.user.last_login_at")
lcUserLocale = loJResp.StringOf("activity.user.locale")
lcUserLocale_id = loJResp.StringOf("activity.user.locale_id")
lcUserModerator = loJResp.StringOf("activity.user.moderator")
lcUserNotes = loJResp.StringOf("activity.user.notes")
lcUserOnly_private_comments = loJResp.StringOf("activity.user.only_private_comments")
lcUserOrganization_id = loJResp.StringOf("activity.user.organization_id")
lcUserPhone = loJResp.StringOf("activity.user.phone")
llVelit_d = loJResp.BoolOf("activity.user.photo.velit_d")
lnNulla68_ = loJResp.IntOf("activity.user.photo.nulla68_")
lcElit1 = loJResp.StringOf("activity.user.photo.elit1")
lcUserRemote_photo_url = loJResp.StringOf("activity.user.remote_photo_url")
lcUserReport_csv = loJResp.StringOf("activity.user.report_csv")
lcUserRestricted_agent = loJResp.StringOf("activity.user.restricted_agent")
lcUserRole = loJResp.StringOf("activity.user.role")
lcUserRole_type = loJResp.StringOf("activity.user.role_type")
lcUserShared = loJResp.StringOf("activity.user.shared")
lcUserShared_agent = loJResp.StringOf("activity.user.shared_agent")
lcUserShared_phone_number = loJResp.StringOf("activity.user.shared_phone_number")
lcUserSignature = loJResp.StringOf("activity.user.signature")
lcUserSuspended = loJResp.StringOf("activity.user.suspended")
lcUserTags = loJResp.StringOf("activity.user.tags")
lcUserTicket_restriction = loJResp.StringOf("activity.user.ticket_restriction")
lcUserTime_zone = loJResp.StringOf("activity.user.time_zone")
lcUserTwo_factor_auth_enabled = loJResp.StringOf("activity.user.two_factor_auth_enabled")
lcUserUpdated_at = loJResp.StringOf("activity.user.updated_at")
lcUserUrl = loJResp.StringOf("activity.user.url")
lnDolor_c26 = loJResp.IntOf("activity.user.user_fields.dolor_c26")
lcElit891 = loJResp.StringOf("activity.user.user_fields.elit891")
lcAmet8 = loJResp.StringOf("activity.user.user_fields.amet8")
lcUserVerified = loJResp.StringOf("activity.user.verified")
lcUser_id = loJResp.StringOf("activity.user_id")
lcVerb = loJResp.StringOf("activity.verb")


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}