DescribeComments VB.NET Example
' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim rest As New Chilkat.Rest
Dim success As Boolean
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "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.)
authAws.Region = "us-west-2"
authAws.ServiceName = "workdocs"
' SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
' URL: https://workdocs.us-west-2.amazonaws.com/
' Use the same region as specified above.
success = rest.Connect("workdocs.us-west-2.amazonaws.com",443,True,True)
If (success <> True) Then
Debug.WriteLine("ConnectFailReason: " & rest.ConnectFailReason)
Debug.WriteLine(rest.LastErrorText)
Exit Sub
End If
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeComments")
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",sbResponseBody)
If (success <> True) Then
Debug.WriteLine(rest.LastErrorText)
Exit Sub
End If
Dim respStatusCode As Integer = rest.ResponseStatusCode
Debug.WriteLine("response status code = " & respStatusCode)
If (respStatusCode <> 200) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(rest.ResponseHeader)
Debug.WriteLine("Response Body:")
Debug.WriteLine(sbResponseBody.GetAsString())
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(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
Dim CommentId As String
Dim CreatedTimestamp As Integer
Dim EmailAddress As String
Dim GivenName As String
Dim Id As String
Dim Locale As String
Dim ModifiedTimestamp As Integer
Dim OrganizationId As String
Dim RecycleBinFolderId As String
Dim RootFolderId As String
Dim Status As String
Dim StorageAllocatedInBytes As Integer
Dim StorageType As String
Dim StorageUtilizedInBytes As Integer
Dim Surname As String
Dim TimeZoneId As String
Dim v_Type As String
Dim Username As String
Dim ParentId As String
Dim RecipientId As String
Dim Text As String
Dim ThreadId As String
Dim Visibility As String
Dim Marker As String = jResp.StringOf("Marker")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("Comments")
While i < count_i
jResp.I = i
CommentId = jResp.StringOf("Comments[i].CommentId")
CreatedTimestamp = jResp.IntOf("Comments[i].Contributor.CreatedTimestamp")
EmailAddress = jResp.StringOf("Comments[i].Contributor.EmailAddress")
GivenName = jResp.StringOf("Comments[i].Contributor.GivenName")
Id = jResp.StringOf("Comments[i].Contributor.Id")
Locale = jResp.StringOf("Comments[i].Contributor.Locale")
ModifiedTimestamp = jResp.IntOf("Comments[i].Contributor.ModifiedTimestamp")
OrganizationId = jResp.StringOf("Comments[i].Contributor.OrganizationId")
RecycleBinFolderId = jResp.StringOf("Comments[i].Contributor.RecycleBinFolderId")
RootFolderId = jResp.StringOf("Comments[i].Contributor.RootFolderId")
Status = jResp.StringOf("Comments[i].Contributor.Status")
StorageAllocatedInBytes = jResp.IntOf("Comments[i].Contributor.Storage.StorageRule.StorageAllocatedInBytes")
StorageType = jResp.StringOf("Comments[i].Contributor.Storage.StorageRule.StorageType")
StorageUtilizedInBytes = jResp.IntOf("Comments[i].Contributor.Storage.StorageUtilizedInBytes")
Surname = jResp.StringOf("Comments[i].Contributor.Surname")
TimeZoneId = jResp.StringOf("Comments[i].Contributor.TimeZoneId")
v_Type = jResp.StringOf("Comments[i].Contributor.Type")
Username = jResp.StringOf("Comments[i].Contributor.Username")
CreatedTimestamp = jResp.IntOf("Comments[i].CreatedTimestamp")
ParentId = jResp.StringOf("Comments[i].ParentId")
RecipientId = jResp.StringOf("Comments[i].RecipientId")
Status = jResp.StringOf("Comments[i].Status")
Text = jResp.StringOf("Comments[i].Text")
ThreadId = jResp.StringOf("Comments[i].ThreadId")
Visibility = jResp.StringOf("Comments[i].Visibility")
i = i + 1
End While
' A sample JSON response body parsed by the above code:
' {
' "Comments": [
' {
' "CommentId": "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,
' "ParentId": "string",
' "RecipientId": "string",
' "Status": "string",
' "Text": "string",
' "ThreadId": "string",
' "Visibility": "string"
' }
' ],
' "Marker": "string"
' }