PureBasic / Support API / Show Activity
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/activities/:activity_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
Name.s = CkJsonObject::ckStringOf(jResp,"activity.actor.name")
Active.s = CkJsonObject::ckStringOf(jResp,"activity.actor.active")
Alias.s = CkJsonObject::ckStringOf(jResp,"activity.actor.alias")
Chat_only.s = CkJsonObject::ckStringOf(jResp,"activity.actor.chat_only")
Created_at.s = CkJsonObject::ckStringOf(jResp,"activity.actor.created_at")
Custom_role_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.custom_role_id")
Default_group_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.default_group_id")
Details.s = CkJsonObject::ckStringOf(jResp,"activity.actor.details")
v_Email.s = CkJsonObject::ckStringOf(jResp,"activity.actor.email")
External_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.external_id")
Iana_time_zone.s = CkJsonObject::ckStringOf(jResp,"activity.actor.iana_time_zone")
Id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.id")
Last_login_at.s = CkJsonObject::ckStringOf(jResp,"activity.actor.last_login_at")
Locale.s = CkJsonObject::ckStringOf(jResp,"activity.actor.locale")
Locale_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.locale_id")
Moderator.s = CkJsonObject::ckStringOf(jResp,"activity.actor.moderator")
Notes.s = CkJsonObject::ckStringOf(jResp,"activity.actor.notes")
Only_private_comments.s = CkJsonObject::ckStringOf(jResp,"activity.actor.only_private_comments")
Organization_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor.organization_id")
Phone.s = CkJsonObject::ckStringOf(jResp,"activity.actor.phone")
Laborum485.s = CkJsonObject::ckStringOf(jResp,"activity.actor.photo.laborum485")
Incididuntfe4.s = CkJsonObject::ckStringOf(jResp,"activity.actor.photo.incididuntfe4")
Ipsum_d.i = CkJsonObject::ckBoolOf(jResp,"activity.actor.photo.ipsum_d")
Non_4a.i = CkJsonObject::ckIntOf(jResp,"activity.actor.photo.non_4a")
Remote_photo_url.s = CkJsonObject::ckStringOf(jResp,"activity.actor.remote_photo_url")
Report_csv.s = CkJsonObject::ckStringOf(jResp,"activity.actor.report_csv")
Restricted_agent.s = CkJsonObject::ckStringOf(jResp,"activity.actor.restricted_agent")
Role.s = CkJsonObject::ckStringOf(jResp,"activity.actor.role")
Role_type.s = CkJsonObject::ckStringOf(jResp,"activity.actor.role_type")
v_Shared.s = CkJsonObject::ckStringOf(jResp,"activity.actor.shared")
Shared_agent.s = CkJsonObject::ckStringOf(jResp,"activity.actor.shared_agent")
Shared_phone_number.s = CkJsonObject::ckStringOf(jResp,"activity.actor.shared_phone_number")
Signature.s = CkJsonObject::ckStringOf(jResp,"activity.actor.signature")
Suspended.s = CkJsonObject::ckStringOf(jResp,"activity.actor.suspended")
Tags.s = CkJsonObject::ckStringOf(jResp,"activity.actor.tags")
Ticket_restriction.s = CkJsonObject::ckStringOf(jResp,"activity.actor.ticket_restriction")
Time_zone.s = CkJsonObject::ckStringOf(jResp,"activity.actor.time_zone")
Two_factor_auth_enabled.s = CkJsonObject::ckStringOf(jResp,"activity.actor.two_factor_auth_enabled")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"activity.actor.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"activity.actor.url")
Aute_e0.i = CkJsonObject::ckBoolOf(jResp,"activity.actor.user_fields.aute_e0")
Quis02.i = CkJsonObject::ckIntOf(jResp,"activity.actor.user_fields.quis02")
Verified.s = CkJsonObject::ckStringOf(jResp,"activity.actor.verified")
Actor_id.s = CkJsonObject::ckStringOf(jResp,"activity.actor_id")
activityCreated_at.s = CkJsonObject::ckStringOf(jResp,"activity.created_at")
activityId.s = CkJsonObject::ckStringOf(jResp,"activity.id")
Consequatf61.i = CkJsonObject::ckIntOf(jResp,"activity.object.consequatf61")
Labore__6.i = CkJsonObject::ckBoolOf(jResp,"activity.object.labore__6")
Anim_f0.i = CkJsonObject::ckIntOf(jResp,"activity.target.anim_f0")
Deserunt_fb.s = CkJsonObject::ckStringOf(jResp,"activity.target.deserunt_fb")
Title.s = CkJsonObject::ckStringOf(jResp,"activity.title")
activityUpdated_at.s = CkJsonObject::ckStringOf(jResp,"activity.updated_at")
activityUrl.s = CkJsonObject::ckStringOf(jResp,"activity.url")
UserName.s = CkJsonObject::ckStringOf(jResp,"activity.user.name")
UserActive.s = CkJsonObject::ckStringOf(jResp,"activity.user.active")
UserAlias.s = CkJsonObject::ckStringOf(jResp,"activity.user.alias")
UserChat_only.s = CkJsonObject::ckStringOf(jResp,"activity.user.chat_only")
UserCreated_at.s = CkJsonObject::ckStringOf(jResp,"activity.user.created_at")
UserCustom_role_id.s = CkJsonObject::ckStringOf(jResp,"activity.user.custom_role_id")
UserDefault_group_id.s = CkJsonObject::ckStringOf(jResp,"activity.user.default_group_id")
UserDetails.s = CkJsonObject::ckStringOf(jResp,"activity.user.details")
UserEmail.s = CkJsonObject::ckStringOf(jResp,"activity.user.email")
UserExternal_id.s = CkJsonObject::ckStringOf(jResp,"activity.user.external_id")
UserIana_time_zone.s = CkJsonObject::ckStringOf(jResp,"activity.user.iana_time_zone")
UserId.s = CkJsonObject::ckStringOf(jResp,"activity.user.id")
UserLast_login_at.s = CkJsonObject::ckStringOf(jResp,"activity.user.last_login_at")
UserLocale.s = CkJsonObject::ckStringOf(jResp,"activity.user.locale")
UserLocale_id.s = CkJsonObject::ckStringOf(jResp,"activity.user.locale_id")
UserModerator.s = CkJsonObject::ckStringOf(jResp,"activity.user.moderator")
UserNotes.s = CkJsonObject::ckStringOf(jResp,"activity.user.notes")
UserOnly_private_comments.s = CkJsonObject::ckStringOf(jResp,"activity.user.only_private_comments")
UserOrganization_id.s = CkJsonObject::ckStringOf(jResp,"activity.user.organization_id")
UserPhone.s = CkJsonObject::ckStringOf(jResp,"activity.user.phone")
Velit_d.i = CkJsonObject::ckBoolOf(jResp,"activity.user.photo.velit_d")
Nulla68_.i = CkJsonObject::ckIntOf(jResp,"activity.user.photo.nulla68_")
Elit1.s = CkJsonObject::ckStringOf(jResp,"activity.user.photo.elit1")
UserRemote_photo_url.s = CkJsonObject::ckStringOf(jResp,"activity.user.remote_photo_url")
UserReport_csv.s = CkJsonObject::ckStringOf(jResp,"activity.user.report_csv")
UserRestricted_agent.s = CkJsonObject::ckStringOf(jResp,"activity.user.restricted_agent")
UserRole.s = CkJsonObject::ckStringOf(jResp,"activity.user.role")
UserRole_type.s = CkJsonObject::ckStringOf(jResp,"activity.user.role_type")
UserShared.s = CkJsonObject::ckStringOf(jResp,"activity.user.shared")
UserShared_agent.s = CkJsonObject::ckStringOf(jResp,"activity.user.shared_agent")
UserShared_phone_number.s = CkJsonObject::ckStringOf(jResp,"activity.user.shared_phone_number")
UserSignature.s = CkJsonObject::ckStringOf(jResp,"activity.user.signature")
UserSuspended.s = CkJsonObject::ckStringOf(jResp,"activity.user.suspended")
UserTags.s = CkJsonObject::ckStringOf(jResp,"activity.user.tags")
UserTicket_restriction.s = CkJsonObject::ckStringOf(jResp,"activity.user.ticket_restriction")
UserTime_zone.s = CkJsonObject::ckStringOf(jResp,"activity.user.time_zone")
UserTwo_factor_auth_enabled.s = CkJsonObject::ckStringOf(jResp,"activity.user.two_factor_auth_enabled")
UserUpdated_at.s = CkJsonObject::ckStringOf(jResp,"activity.user.updated_at")
UserUrl.s = CkJsonObject::ckStringOf(jResp,"activity.user.url")
Dolor_c26.i = CkJsonObject::ckIntOf(jResp,"activity.user.user_fields.dolor_c26")
Elit891.s = CkJsonObject::ckStringOf(jResp,"activity.user.user_fields.elit891")
Amet8.s = CkJsonObject::ckStringOf(jResp,"activity.user.user_fields.amet8")
UserVerified.s = CkJsonObject::ckStringOf(jResp,"activity.user.verified")
User_id.s = CkJsonObject::ckStringOf(jResp,"activity.user_id")
Verb.s = CkJsonObject::ckStringOf(jResp,"activity.verb")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
