DescribeActivities PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "workdocs")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://workdocs.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"workdocs.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeActivities")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestNoBodySb(rest,"GET","/api/v1/activities",sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
; The following code parses the JSON response.
; A sample JSON response is shown below the sample code.
; Use this online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON
CommentId.s
CommentStatus.s
CreatedTimestamp.i
EmailAddress.s
GivenName.s
Id.s
Locale.s
ModifiedTimestamp.i
OrganizationId.s
RecycleBinFolderId.s
RootFolderId.s
Status.s
StorageAllocatedInBytes.i
StorageType.s
StorageUtilizedInBytes.i
Surname.s
TimeZoneId.s
v_Type.s
Username.s
CommentMetadataCreatedTimestamp.i
RecipientId.s
InitiatorEmailAddress.s
InitiatorGivenName.s
InitiatorId.s
InitiatorSurname.s
InitiatorUsername.s
IsIndirectActivity.i
OriginalParentId.s
Name.s
OriginalName.s
OwnerEmailAddress.s
OwnerGivenName.s
OwnerId.s
OwnerSurname.s
OwnerUsername.s
ParentId.s
OriginalParentType.s
VersionId.s
ResourceMetadataId.s
ResourceMetadataName.s
ResourceMetadataOriginalName.s
ResourceMetadataParentId.s
ResourceMetadataType.s
ResourceMetadataVersionId.s
TimeStamp.i
j.i
count_j.i
Marker.s = CkJsonObject::ckStringOf(jResp,"Marker")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"UserActivities")
While i < count_i
CkJsonObject::setCkI(jResp, i)
CommentId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.CommentId")
CommentStatus = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.CommentStatus")
CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"UserActivities[i].CommentMetadata.Contributor.CreatedTimestamp")
EmailAddress = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.EmailAddress")
GivenName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.GivenName")
Id = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Id")
Locale = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Locale")
ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"UserActivities[i].CommentMetadata.Contributor.ModifiedTimestamp")
OrganizationId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.OrganizationId")
RecycleBinFolderId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.RecycleBinFolderId")
RootFolderId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.RootFolderId")
Status = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Status")
StorageAllocatedInBytes = CkJsonObject::ckIntOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Storage.StorageRule.StorageAllocatedInBytes")
StorageType = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Storage.StorageRule.StorageType")
StorageUtilizedInBytes = CkJsonObject::ckIntOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Storage.StorageUtilizedInBytes")
Surname = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Surname")
TimeZoneId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.TimeZoneId")
v_Type = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Type")
Username = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.Contributor.Username")
CommentMetadataCreatedTimestamp = CkJsonObject::ckIntOf(jResp,"UserActivities[i].CommentMetadata.CreatedTimestamp")
RecipientId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].CommentMetadata.RecipientId")
InitiatorEmailAddress = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Initiator.EmailAddress")
InitiatorGivenName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Initiator.GivenName")
InitiatorId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Initiator.Id")
InitiatorSurname = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Initiator.Surname")
InitiatorUsername = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Initiator.Username")
IsIndirectActivity = CkJsonObject::ckIntOf(jResp,"UserActivities[i].IsIndirectActivity")
OrganizationId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OrganizationId")
OriginalParentId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Id")
Name = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Name")
OriginalName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.OriginalName")
OwnerEmailAddress = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Owner.EmailAddress")
OwnerGivenName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Owner.GivenName")
OwnerId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Owner.Id")
OwnerSurname = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Owner.Surname")
OwnerUsername = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Owner.Username")
ParentId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.ParentId")
OriginalParentType = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.Type")
VersionId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].OriginalParent.VersionId")
ResourceMetadataId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Id")
ResourceMetadataName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Name")
ResourceMetadataOriginalName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.OriginalName")
OwnerEmailAddress = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Owner.EmailAddress")
OwnerGivenName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Owner.GivenName")
OwnerId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Owner.Id")
OwnerSurname = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Owner.Surname")
OwnerUsername = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Owner.Username")
ResourceMetadataParentId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.ParentId")
ResourceMetadataType = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.Type")
ResourceMetadataVersionId = CkJsonObject::ckStringOf(jResp,"UserActivities[i].ResourceMetadata.VersionId")
TimeStamp = CkJsonObject::ckIntOf(jResp,"UserActivities[i].TimeStamp")
v_Type = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"UserActivities[i].Participants.Groups")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Id = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Groups[j].Id")
Name = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Groups[j].Name")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"UserActivities[i].Participants.Users")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
EmailAddress = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Users[j].EmailAddress")
GivenName = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Users[j].GivenName")
Id = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Users[j].Id")
Surname = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Users[j].Surname")
Username = CkJsonObject::ckStringOf(jResp,"UserActivities[i].Participants.Users[j].Username")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Marker": "string",
; "UserActivities": [
; {
; "CommentMetadata": {
; "CommentId": "string",
; "CommentStatus": "string",
; "Contributor": {
; "CreatedTimestamp": number,
; "EmailAddress": "string",
; "GivenName": "string",
; "Id": "string",
; "Locale": "string",
; "ModifiedTimestamp": number,
; "OrganizationId": "string",
; "RecycleBinFolderId": "string",
; "RootFolderId": "string",
; "Status": "string",
; "Storage": {
; "StorageRule": {
; "StorageAllocatedInBytes": number,
; "StorageType": "string"
; },
; "StorageUtilizedInBytes": number
; },
; "Surname": "string",
; "TimeZoneId": "string",
; "Type": "string",
; "Username": "string"
; },
; "CreatedTimestamp": number,
; "RecipientId": "string"
; },
; "Initiator": {
; "EmailAddress": "string",
; "GivenName": "string",
; "Id": "string",
; "Surname": "string",
; "Username": "string"
; },
; "IsIndirectActivity": boolean,
; "OrganizationId": "string",
; "OriginalParent": {
; "Id": "string",
; "Name": "string",
; "OriginalName": "string",
; "Owner": {
; "EmailAddress": "string",
; "GivenName": "string",
; "Id": "string",
; "Surname": "string",
; "Username": "string"
; },
; "ParentId": "string",
; "Type": "string",
; "VersionId": "string"
; },
; "Participants": {
; "Groups": [
; {
; "Id": "string",
; "Name": "string"
; }
; ],
; "Users": [
; {
; "EmailAddress": "string",
; "GivenName": "string",
; "Id": "string",
; "Surname": "string",
; "Username": "string"
; }
; ]
; },
; "ResourceMetadata": {
; "Id": "string",
; "Name": "string",
; "OriginalName": "string",
; "Owner": {
; "EmailAddress": "string",
; "GivenName": "string",
; "Id": "string",
; "Surname": "string",
; "Username": "string"
; },
; "ParentId": "string",
; "Type": "string",
; "VersionId": "string"
; },
; "TimeStamp": number,
; "Type": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
