Chilkat Online Tools

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

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

    ContentCreatedTimestamp.i
    ContentModifiedTimestamp.i
    ContentType.s
    CreatedTimestamp.i
    CreatorId.s
    Id.s
    ModifiedTimestamp.i
    Name.s
    Signature.s
    Size.i
    v_String.s
    Status.s
    ThumbnailString.s

    Marker.s = CkJsonObject::ckStringOf(jResp,"Marker")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"DocumentVersions")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        ContentCreatedTimestamp = CkJsonObject::ckIntOf(jResp,"DocumentVersions[i].ContentCreatedTimestamp")
        ContentModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"DocumentVersions[i].ContentModifiedTimestamp")
        ContentType = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].ContentType")
        CreatedTimestamp = CkJsonObject::ckIntOf(jResp,"DocumentVersions[i].CreatedTimestamp")
        CreatorId = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].CreatorId")
        Id = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Id")
        ModifiedTimestamp = CkJsonObject::ckIntOf(jResp,"DocumentVersions[i].ModifiedTimestamp")
        Name = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Name")
        Signature = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Signature")
        Size = CkJsonObject::ckIntOf(jResp,"DocumentVersions[i].Size")
        v_String = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Source.string")
        Status = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Status")
        ThumbnailString = CkJsonObject::ckStringOf(jResp,"DocumentVersions[i].Thumbnail.string")
        i = i + 1
    Wend

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

    ; {
    ;   "DocumentVersions": [
    ;     {
    ;       "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"
    ;       }
    ;     }
    ;   ],
    ;   "Marker": "string"
    ; }


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


    ProcedureReturn
EndProcedure