Send a REST Request with a Binary Body

See more REST Examples

Demonstrates Rest.FullRequestBd, which sends a complete request whose binary body is read from a BinData and stores the text response body in a StringBuilder.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

IncludeFile "CkBinData.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    bTls.i = 1
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"example.com",443,bTls,bAutoReconnect)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ;  The file paths are relative to the application's current working directory.  Absolute paths
    ;  may also be used.  Supply the paths appropriate to your own environment.

    ;  FullRequestBd sends a request whose binary body is read from a BinData and stores the text
    ;  response body in a StringBuilder.
    bdRequest.i = CkBinData::ckCreate()
    If bdRequest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bLoaded.i = CkBinData::ckLoadFile(bdRequest,"qa_data/image.png")
    If bLoaded <> 1
        Debug "Failed to load the request body file."
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdRequest)
        ProcedureReturn
    EndIf

    CkRest::ckAddHeader(rest,"Content-Type","image/png")

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

    success = CkRest::ckFullRequestBd(rest,"PUT","/api/images/1",bdRequest,sbResponse)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdRequest)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    responseText.s = CkStringBuilder::ckGetAsString(sbResponse)
    If CkStringBuilder::ckLastMethodSuccess(sbResponse) = 0
        Debug CkStringBuilder::ckLastErrorText(sbResponse)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdRequest)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    Debug responseText


    CkRest::ckDispose(rest)
    CkBinData::ckDispose(bdRequest)
    CkStringBuilder::ckDispose(sbResponse)


    ProcedureReturn
EndProcedure