Chilkat Online Tools

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/activities/:activity_id",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

Dim Name As String
Name = jResp.StringOf("activity.actor.name")
Dim Active As String
Active = jResp.StringOf("activity.actor.active")
Dim Alias As String
Alias = jResp.StringOf("activity.actor.alias")
Dim Chat_only As String
Chat_only = jResp.StringOf("activity.actor.chat_only")
Dim Created_at As String
Created_at = jResp.StringOf("activity.actor.created_at")
Dim Custom_role_id As String
Custom_role_id = jResp.StringOf("activity.actor.custom_role_id")
Dim Default_group_id As String
Default_group_id = jResp.StringOf("activity.actor.default_group_id")
Dim Details As String
Details = jResp.StringOf("activity.actor.details")
Dim v_Email As String
v_Email = jResp.StringOf("activity.actor.email")
Dim External_id As String
External_id = jResp.StringOf("activity.actor.external_id")
Dim Iana_time_zone As String
Iana_time_zone = jResp.StringOf("activity.actor.iana_time_zone")
Dim Id As String
Id = jResp.StringOf("activity.actor.id")
Dim Last_login_at As String
Last_login_at = jResp.StringOf("activity.actor.last_login_at")
Dim Locale As String
Locale = jResp.StringOf("activity.actor.locale")
Dim Locale_id As String
Locale_id = jResp.StringOf("activity.actor.locale_id")
Dim Moderator As String
Moderator = jResp.StringOf("activity.actor.moderator")
Dim Notes As String
Notes = jResp.StringOf("activity.actor.notes")
Dim Only_private_comments As String
Only_private_comments = jResp.StringOf("activity.actor.only_private_comments")
Dim Organization_id As String
Organization_id = jResp.StringOf("activity.actor.organization_id")
Dim Phone As String
Phone = jResp.StringOf("activity.actor.phone")
Dim Laborum485 As String
Laborum485 = jResp.StringOf("activity.actor.photo.laborum485")
Dim Incididuntfe4 As String
Incididuntfe4 = jResp.StringOf("activity.actor.photo.incididuntfe4")
Dim Ipsum_d As Boolean
Ipsum_d = jResp.BoolOf("activity.actor.photo.ipsum_d")
Dim Non_4a As Int32
Non_4a = jResp.IntOf("activity.actor.photo.non_4a")
Dim Remote_photo_url As String
Remote_photo_url = jResp.StringOf("activity.actor.remote_photo_url")
Dim Report_csv As String
Report_csv = jResp.StringOf("activity.actor.report_csv")
Dim Restricted_agent As String
Restricted_agent = jResp.StringOf("activity.actor.restricted_agent")
Dim Role As String
Role = jResp.StringOf("activity.actor.role")
Dim Role_type As String
Role_type = jResp.StringOf("activity.actor.role_type")
Dim v_Shared As String
v_Shared = jResp.StringOf("activity.actor.shared")
Dim Shared_agent As String
Shared_agent = jResp.StringOf("activity.actor.shared_agent")
Dim Shared_phone_number As String
Shared_phone_number = jResp.StringOf("activity.actor.shared_phone_number")
Dim Signature As String
Signature = jResp.StringOf("activity.actor.signature")
Dim Suspended As String
Suspended = jResp.StringOf("activity.actor.suspended")
Dim Tags As String
Tags = jResp.StringOf("activity.actor.tags")
Dim Ticket_restriction As String
Ticket_restriction = jResp.StringOf("activity.actor.ticket_restriction")
Dim Time_zone As String
Time_zone = jResp.StringOf("activity.actor.time_zone")
Dim Two_factor_auth_enabled As String
Two_factor_auth_enabled = jResp.StringOf("activity.actor.two_factor_auth_enabled")
Dim Updated_at As String
Updated_at = jResp.StringOf("activity.actor.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("activity.actor.url")
Dim Aute_e0 As Boolean
Aute_e0 = jResp.BoolOf("activity.actor.user_fields.aute_e0")
Dim Quis02 As Int32
Quis02 = jResp.IntOf("activity.actor.user_fields.quis02")
Dim Verified As String
Verified = jResp.StringOf("activity.actor.verified")
Dim Actor_id As String
Actor_id = jResp.StringOf("activity.actor_id")
Dim activityCreated_at As String
activityCreated_at = jResp.StringOf("activity.created_at")
Dim activityId As String
activityId = jResp.StringOf("activity.id")
Dim Consequatf61 As Int32
Consequatf61 = jResp.IntOf("activity.object.consequatf61")
Dim Labore__6 As Boolean
Labore__6 = jResp.BoolOf("activity.object.labore__6")
Dim Anim_f0 As Int32
Anim_f0 = jResp.IntOf("activity.target.anim_f0")
Dim Deserunt_fb As String
Deserunt_fb = jResp.StringOf("activity.target.deserunt_fb")
Dim Title As String
Title = jResp.StringOf("activity.title")
Dim activityUpdated_at As String
activityUpdated_at = jResp.StringOf("activity.updated_at")
Dim activityUrl As String
activityUrl = jResp.StringOf("activity.url")
Dim UserName As String
UserName = jResp.StringOf("activity.user.name")
Dim UserActive As String
UserActive = jResp.StringOf("activity.user.active")
Dim UserAlias As String
UserAlias = jResp.StringOf("activity.user.alias")
Dim UserChat_only As String
UserChat_only = jResp.StringOf("activity.user.chat_only")
Dim UserCreated_at As String
UserCreated_at = jResp.StringOf("activity.user.created_at")
Dim UserCustom_role_id As String
UserCustom_role_id = jResp.StringOf("activity.user.custom_role_id")
Dim UserDefault_group_id As String
UserDefault_group_id = jResp.StringOf("activity.user.default_group_id")
Dim UserDetails As String
UserDetails = jResp.StringOf("activity.user.details")
Dim UserEmail As String
UserEmail = jResp.StringOf("activity.user.email")
Dim UserExternal_id As String
UserExternal_id = jResp.StringOf("activity.user.external_id")
Dim UserIana_time_zone As String
UserIana_time_zone = jResp.StringOf("activity.user.iana_time_zone")
Dim UserId As String
UserId = jResp.StringOf("activity.user.id")
Dim UserLast_login_at As String
UserLast_login_at = jResp.StringOf("activity.user.last_login_at")
Dim UserLocale As String
UserLocale = jResp.StringOf("activity.user.locale")
Dim UserLocale_id As String
UserLocale_id = jResp.StringOf("activity.user.locale_id")
Dim UserModerator As String
UserModerator = jResp.StringOf("activity.user.moderator")
Dim UserNotes As String
UserNotes = jResp.StringOf("activity.user.notes")
Dim UserOnly_private_comments As String
UserOnly_private_comments = jResp.StringOf("activity.user.only_private_comments")
Dim UserOrganization_id As String
UserOrganization_id = jResp.StringOf("activity.user.organization_id")
Dim UserPhone As String
UserPhone = jResp.StringOf("activity.user.phone")
Dim Velit_d As Boolean
Velit_d = jResp.BoolOf("activity.user.photo.velit_d")
Dim Nulla68_ As Int32
Nulla68_ = jResp.IntOf("activity.user.photo.nulla68_")
Dim Elit1 As String
Elit1 = jResp.StringOf("activity.user.photo.elit1")
Dim UserRemote_photo_url As String
UserRemote_photo_url = jResp.StringOf("activity.user.remote_photo_url")
Dim UserReport_csv As String
UserReport_csv = jResp.StringOf("activity.user.report_csv")
Dim UserRestricted_agent As String
UserRestricted_agent = jResp.StringOf("activity.user.restricted_agent")
Dim UserRole As String
UserRole = jResp.StringOf("activity.user.role")
Dim UserRole_type As String
UserRole_type = jResp.StringOf("activity.user.role_type")
Dim UserShared As String
UserShared = jResp.StringOf("activity.user.shared")
Dim UserShared_agent As String
UserShared_agent = jResp.StringOf("activity.user.shared_agent")
Dim UserShared_phone_number As String
UserShared_phone_number = jResp.StringOf("activity.user.shared_phone_number")
Dim UserSignature As String
UserSignature = jResp.StringOf("activity.user.signature")
Dim UserSuspended As String
UserSuspended = jResp.StringOf("activity.user.suspended")
Dim UserTags As String
UserTags = jResp.StringOf("activity.user.tags")
Dim UserTicket_restriction As String
UserTicket_restriction = jResp.StringOf("activity.user.ticket_restriction")
Dim UserTime_zone As String
UserTime_zone = jResp.StringOf("activity.user.time_zone")
Dim UserTwo_factor_auth_enabled As String
UserTwo_factor_auth_enabled = jResp.StringOf("activity.user.two_factor_auth_enabled")
Dim UserUpdated_at As String
UserUpdated_at = jResp.StringOf("activity.user.updated_at")
Dim UserUrl As String
UserUrl = jResp.StringOf("activity.user.url")
Dim Dolor_c26 As Int32
Dolor_c26 = jResp.IntOf("activity.user.user_fields.dolor_c26")
Dim Elit891 As String
Elit891 = jResp.StringOf("activity.user.user_fields.elit891")
Dim Amet8 As String
Amet8 = jResp.StringOf("activity.user.user_fields.amet8")
Dim UserVerified As String
UserVerified = jResp.StringOf("activity.user.verified")
Dim User_id As String
User_id = jResp.StringOf("activity.user_id")
Dim Verb As String
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}"
    }
  ]
}