Chilkat Online Tools

DescribeComments PureBasic Example

Amazon WorkDocs

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","DescribeComments")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",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
    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
    ParentId.s
    RecipientId.s
    Text.s
    ThreadId.s
    Visibility.s

    Marker.s = CkJsonObject::ckStringOf(jResp,"Marker")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Comments")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        CommentId = CkJsonObject::ckStringOf(jResp,"Comments[i].CommentId")
        CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Comments[i].Contributor.CreatedTimestamp")
        EmailAddress = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.EmailAddress")
        GivenName = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.GivenName")
        Id = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Id")
        Locale = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Locale")
        ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"Comments[i].Contributor.ModifiedTimestamp")
        OrganizationId = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.OrganizationId")
        RecycleBinFolderId = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.RecycleBinFolderId")
        RootFolderId = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.RootFolderId")
        Status = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Status")
        StorageAllocatedInBytes = CkJsonObject::ckIntOf(jResp,"Comments[i].Contributor.Storage.StorageRule.StorageAllocatedInBytes")
        StorageType = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Storage.StorageRule.StorageType")
        StorageUtilizedInBytes = CkJsonObject::ckIntOf(jResp,"Comments[i].Contributor.Storage.StorageUtilizedInBytes")
        Surname = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Surname")
        TimeZoneId = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.TimeZoneId")
        v_Type = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Type")
        Username = CkJsonObject::ckStringOf(jResp,"Comments[i].Contributor.Username")
        CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Comments[i].CreatedTimestamp")
        ParentId = CkJsonObject::ckStringOf(jResp,"Comments[i].ParentId")
        RecipientId = CkJsonObject::ckStringOf(jResp,"Comments[i].RecipientId")
        Status = CkJsonObject::ckStringOf(jResp,"Comments[i].Status")
        Text = CkJsonObject::ckStringOf(jResp,"Comments[i].Text")
        ThreadId = CkJsonObject::ckStringOf(jResp,"Comments[i].ThreadId")
        Visibility = CkJsonObject::ckStringOf(jResp,"Comments[i].Visibility")
        i = i + 1
    Wend

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


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure