Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/activities/:activity_id",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sName = $oJResp.StringOf("activity.actor.name")
Local $sActive = $oJResp.StringOf("activity.actor.active")
Local $sAlias = $oJResp.StringOf("activity.actor.alias")
Local $sChat_only = $oJResp.StringOf("activity.actor.chat_only")
Local $sCreated_at = $oJResp.StringOf("activity.actor.created_at")
Local $sCustom_role_id = $oJResp.StringOf("activity.actor.custom_role_id")
Local $sDefault_group_id = $oJResp.StringOf("activity.actor.default_group_id")
Local $sDetails = $oJResp.StringOf("activity.actor.details")
Local $sV_Email = $oJResp.StringOf("activity.actor.email")
Local $sExternal_id = $oJResp.StringOf("activity.actor.external_id")
Local $sIana_time_zone = $oJResp.StringOf("activity.actor.iana_time_zone")
Local $sId = $oJResp.StringOf("activity.actor.id")
Local $sLast_login_at = $oJResp.StringOf("activity.actor.last_login_at")
Local $sLocale = $oJResp.StringOf("activity.actor.locale")
Local $sLocale_id = $oJResp.StringOf("activity.actor.locale_id")
Local $sModerator = $oJResp.StringOf("activity.actor.moderator")
Local $sNotes = $oJResp.StringOf("activity.actor.notes")
Local $sOnly_private_comments = $oJResp.StringOf("activity.actor.only_private_comments")
Local $sOrganization_id = $oJResp.StringOf("activity.actor.organization_id")
Local $sPhone = $oJResp.StringOf("activity.actor.phone")
Local $sLaborum485 = $oJResp.StringOf("activity.actor.photo.laborum485")
Local $sIncididuntfe4 = $oJResp.StringOf("activity.actor.photo.incididuntfe4")
Local $bIpsum_d = $oJResp.BoolOf("activity.actor.photo.ipsum_d")
Local $iNon_4a = $oJResp.IntOf("activity.actor.photo.non_4a")
Local $sRemote_photo_url = $oJResp.StringOf("activity.actor.remote_photo_url")
Local $sReport_csv = $oJResp.StringOf("activity.actor.report_csv")
Local $sRestricted_agent = $oJResp.StringOf("activity.actor.restricted_agent")
Local $sRole = $oJResp.StringOf("activity.actor.role")
Local $sRole_type = $oJResp.StringOf("activity.actor.role_type")
Local $sV_Shared = $oJResp.StringOf("activity.actor.shared")
Local $sShared_agent = $oJResp.StringOf("activity.actor.shared_agent")
Local $sShared_phone_number = $oJResp.StringOf("activity.actor.shared_phone_number")
Local $sSignature = $oJResp.StringOf("activity.actor.signature")
Local $sSuspended = $oJResp.StringOf("activity.actor.suspended")
Local $sTags = $oJResp.StringOf("activity.actor.tags")
Local $sTicket_restriction = $oJResp.StringOf("activity.actor.ticket_restriction")
Local $sTime_zone = $oJResp.StringOf("activity.actor.time_zone")
Local $sTwo_factor_auth_enabled = $oJResp.StringOf("activity.actor.two_factor_auth_enabled")
Local $sUpdated_at = $oJResp.StringOf("activity.actor.updated_at")
Local $sV_Url = $oJResp.StringOf("activity.actor.url")
Local $bAute_e0 = $oJResp.BoolOf("activity.actor.user_fields.aute_e0")
Local $iQuis02 = $oJResp.IntOf("activity.actor.user_fields.quis02")
Local $sVerified = $oJResp.StringOf("activity.actor.verified")
Local $sActor_id = $oJResp.StringOf("activity.actor_id")
Local $sActivityCreated_at = $oJResp.StringOf("activity.created_at")
Local $sActivityId = $oJResp.StringOf("activity.id")
Local $iConsequatf61 = $oJResp.IntOf("activity.object.consequatf61")
Local $bLabore__6 = $oJResp.BoolOf("activity.object.labore__6")
Local $iAnim_f0 = $oJResp.IntOf("activity.target.anim_f0")
Local $sDeserunt_fb = $oJResp.StringOf("activity.target.deserunt_fb")
Local $sTitle = $oJResp.StringOf("activity.title")
Local $sActivityUpdated_at = $oJResp.StringOf("activity.updated_at")
Local $sActivityUrl = $oJResp.StringOf("activity.url")
Local $sUserName = $oJResp.StringOf("activity.user.name")
Local $sUserActive = $oJResp.StringOf("activity.user.active")
Local $sUserAlias = $oJResp.StringOf("activity.user.alias")
Local $sUserChat_only = $oJResp.StringOf("activity.user.chat_only")
Local $sUserCreated_at = $oJResp.StringOf("activity.user.created_at")
Local $sUserCustom_role_id = $oJResp.StringOf("activity.user.custom_role_id")
Local $sUserDefault_group_id = $oJResp.StringOf("activity.user.default_group_id")
Local $sUserDetails = $oJResp.StringOf("activity.user.details")
Local $sUserEmail = $oJResp.StringOf("activity.user.email")
Local $sUserExternal_id = $oJResp.StringOf("activity.user.external_id")
Local $sUserIana_time_zone = $oJResp.StringOf("activity.user.iana_time_zone")
Local $sUserId = $oJResp.StringOf("activity.user.id")
Local $sUserLast_login_at = $oJResp.StringOf("activity.user.last_login_at")
Local $sUserLocale = $oJResp.StringOf("activity.user.locale")
Local $sUserLocale_id = $oJResp.StringOf("activity.user.locale_id")
Local $sUserModerator = $oJResp.StringOf("activity.user.moderator")
Local $sUserNotes = $oJResp.StringOf("activity.user.notes")
Local $sUserOnly_private_comments = $oJResp.StringOf("activity.user.only_private_comments")
Local $sUserOrganization_id = $oJResp.StringOf("activity.user.organization_id")
Local $sUserPhone = $oJResp.StringOf("activity.user.phone")
Local $bVelit_d = $oJResp.BoolOf("activity.user.photo.velit_d")
Local $iNulla68_ = $oJResp.IntOf("activity.user.photo.nulla68_")
Local $sElit1 = $oJResp.StringOf("activity.user.photo.elit1")
Local $sUserRemote_photo_url = $oJResp.StringOf("activity.user.remote_photo_url")
Local $sUserReport_csv = $oJResp.StringOf("activity.user.report_csv")
Local $sUserRestricted_agent = $oJResp.StringOf("activity.user.restricted_agent")
Local $sUserRole = $oJResp.StringOf("activity.user.role")
Local $sUserRole_type = $oJResp.StringOf("activity.user.role_type")
Local $sUserShared = $oJResp.StringOf("activity.user.shared")
Local $sUserShared_agent = $oJResp.StringOf("activity.user.shared_agent")
Local $sUserShared_phone_number = $oJResp.StringOf("activity.user.shared_phone_number")
Local $sUserSignature = $oJResp.StringOf("activity.user.signature")
Local $sUserSuspended = $oJResp.StringOf("activity.user.suspended")
Local $sUserTags = $oJResp.StringOf("activity.user.tags")
Local $sUserTicket_restriction = $oJResp.StringOf("activity.user.ticket_restriction")
Local $sUserTime_zone = $oJResp.StringOf("activity.user.time_zone")
Local $sUserTwo_factor_auth_enabled = $oJResp.StringOf("activity.user.two_factor_auth_enabled")
Local $sUserUpdated_at = $oJResp.StringOf("activity.user.updated_at")
Local $sUserUrl = $oJResp.StringOf("activity.user.url")
Local $iDolor_c26 = $oJResp.IntOf("activity.user.user_fields.dolor_c26")
Local $sElit891 = $oJResp.StringOf("activity.user.user_fields.elit891")
Local $sAmet8 = $oJResp.StringOf("activity.user.user_fields.amet8")
Local $sUserVerified = $oJResp.StringOf("activity.user.verified")
Local $sUser_id = $oJResp.StringOf("activity.user_id")
Local $sVerb = $oJResp.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}"
    }
  ]
}