Sample code for 30+ languages & platforms
PureBasic

Send a REST Request using StringBuilder Bodies

See more REST Examples

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

Background. Using StringBuilder objects for the request and response bodies avoids extra string conversions, which is helpful when working with large payloads.

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkRest.pb"
IncludeFile "CkStringBuilder.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

    ;  FullRequestSb sends a request whose text body is read from a StringBuilder and stores the text
    ;  response body in a second StringBuilder.  This avoids extra string conversions for large bodies.
    sbRequest.i = CkStringBuilder::ckCreate()
    If sbRequest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbRequest,"{ " + Chr(34) + "query" + Chr(34) + ": " + Chr(34) + "chilkat" + Chr(34) + " }")

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

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

    success = CkRest::ckFullRequestSb(rest,"POST","/api/search",sbRequest,sbResponse)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbRequest)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

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

    Debug responseText


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbRequest)
    CkStringBuilder::ckDispose(sbResponse)


    ProcedureReturn
EndProcedure