Chilkat Online Tools

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

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

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/api/v1/folders/{FolderId}/contents",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

    CreatedTimestamp.i
    CreatorId.s
    Id.s
    ContentCreatedTimestamp.i
    ContentModifiedTimestamp.i
    ContentType.s
    LatestVersionMetadataCreatedTimestamp.i
    LatestVersionMetadataCreatorId.s
    LatestVersionMetadataId.s
    ModifiedTimestamp.i
    Name.s
    Signature.s
    Size.i
    v_String.s
    Status.s
    ThumbnailString.s
    ParentFolderId.s
    ResourceState.s
    j.i
    count_j.i
    strVal.s
    LatestVersionSize.i

    Marker.s = CkJsonObject::ckStringOf(jResp,"Marker")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Documents")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].CreatedTimestamp")
        CreatorId = CkJsonObject::ckStringOf(jResp,"Documents[i].CreatorId")
        Id = CkJsonObject::ckStringOf(jResp,"Documents[i].Id")
        ContentCreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].LatestVersionMetadata.ContentCreatedTimestamp")
        ContentModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].LatestVersionMetadata.ContentModifiedTimestamp")
        ContentType = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.ContentType")
        LatestVersionMetadataCreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].LatestVersionMetadata.CreatedTimestamp")
        LatestVersionMetadataCreatorId = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.CreatorId")
        LatestVersionMetadataId = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Id")
        ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].LatestVersionMetadata.ModifiedTimestamp")
        Name = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Name")
        Signature = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Signature")
        Size = CkJsonObject::ckIntOf(jResp,"Documents[i].LatestVersionMetadata.Size")
        v_String = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Source.string")
        Status = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Status")
        ThumbnailString = CkJsonObject::ckStringOf(jResp,"Documents[i].LatestVersionMetadata.Thumbnail.string")
        ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"Documents[i].ModifiedTimestamp")
        ParentFolderId = CkJsonObject::ckStringOf(jResp,"Documents[i].ParentFolderId")
        ResourceState = CkJsonObject::ckStringOf(jResp,"Documents[i].ResourceState")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"Documents[i].Labels")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"Documents[i].Labels[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"Folders")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"Folders[i].CreatedTimestamp")
        CreatorId = CkJsonObject::ckStringOf(jResp,"Folders[i].CreatorId")
        Id = CkJsonObject::ckStringOf(jResp,"Folders[i].Id")
        LatestVersionSize = CkJsonObject::ckIntOf(jResp,"Folders[i].LatestVersionSize")
        ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"Folders[i].ModifiedTimestamp")
        Name = CkJsonObject::ckStringOf(jResp,"Folders[i].Name")
        ParentFolderId = CkJsonObject::ckStringOf(jResp,"Folders[i].ParentFolderId")
        ResourceState = CkJsonObject::ckStringOf(jResp,"Folders[i].ResourceState")
        Signature = CkJsonObject::ckStringOf(jResp,"Folders[i].Signature")
        Size = CkJsonObject::ckIntOf(jResp,"Folders[i].Size")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"Folders[i].Labels")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"Folders[i].Labels[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "Documents": [
    ;     {
    ;       "CreatedTimestamp": number,
    ;       "CreatorId": "string",
    ;       "Id": "string",
    ;       "Labels": [
    ;         "string"
    ;       ],
    ;       "LatestVersionMetadata": {
    ;         "ContentCreatedTimestamp": number,
    ;         "ContentModifiedTimestamp": number,
    ;         "ContentType": "string",
    ;         "CreatedTimestamp": number,
    ;         "CreatorId": "string",
    ;         "Id": "string",
    ;         "ModifiedTimestamp": number,
    ;         "Name": "string",
    ;         "Signature": "string",
    ;         "Size": number,
    ;         "Source": {
    ;           "string": "string"
    ;         },
    ;         "Status": "string",
    ;         "Thumbnail": {
    ;           "string": "string"
    ;         }
    ;       },
    ;       "ModifiedTimestamp": number,
    ;       "ParentFolderId": "string",
    ;       "ResourceState": "string"
    ;     }
    ;   ],
    ;   "Folders": [
    ;     {
    ;       "CreatedTimestamp": number,
    ;       "CreatorId": "string",
    ;       "Id": "string",
    ;       "Labels": [
    ;         "string"
    ;       ],
    ;       "LatestVersionSize": number,
    ;       "ModifiedTimestamp": number,
    ;       "Name": "string",
    ;       "ParentFolderId": "string",
    ;       "ResourceState": "string",
    ;       "Signature": "string",
    ;       "Size": number
    ;     }
    ;   ],
    ;   "Marker": "string"
    ; }


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


    ProcedureReturn
EndProcedure