Chilkat Online Tools

DescribeComments Perl Example

Amazon WorkDocs

use chilkat();

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = chilkat::CkRest->new();

$authAws = chilkat::CkAuthAws->new();
$authAws->put_AccessKey("AWS_ACCESS_KEY");
$authAws->put_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->put_Region("us-west-2");
$authAws->put_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,1,1);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$rest->AddHeader("Content-Type","application/x-amz-json-1.1");
$rest->AddHeader("X-Amz-Target","DescribeComments");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print "response status code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 200) {
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$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

$Marker = $jResp->stringOf("Marker");
$i = 0;
$count_i = $jResp->SizeOfArray("Comments");
while ($i < $count_i) {
    $jResp->put_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;
}

# 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"
# }