(PureBasic) Creating an application/json HTTP POST Request

Demonstrates how to create an HTTP POST request having the Content-Type application/json, where the body of the HTTP request is the following JSON:

{
   "username" : "my_username",
   "password" : "my_password",
   "validation-factors" : {
      "validationFactors" : [
         {
            "name" : "remote_address",
            "value" : "127.0.0.1"
         }
      ]
   }
}

The generated HTTP request looks like this:

POST /something HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: domain
Content-Length: 216

{
  "username": "my_username",
  "password": "my_password",
  "validation-factors": {
    "validationFactors": [
      {
        "name": "remote_address",
        "value": "127.0.0.1"
      }
    ]
  }
}

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonArray.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    ; This example demonstrates building an application/json request.

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

    ; The ContentType, HttpVerb, and Path properties should
    ; always be explicitly set.
    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/something")
    CkHttpRequest::setCkContentType(req, "application/json")

    ; We may wish to add an "Accept" header to the request.
    ; This tells the server we'll accept an application/json response.
    CkHttpRequest::ckAddHeader(req,"Accept","application/json")

    ; We'll use Chilkat's JSON API to create the JSON body of the HTTP request.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckAppendString(json,"username","my_username")
    CkJsonObject::ckAppendString(json,"password","my_password")
    vFactors.i = CkJsonObject::ckAppendObject(json,"validation-factors")
    vArray.i = CkJsonObject::ckAppendArray(vFactors,"validationFactors")
    CkJsonArray::ckAddObjectAt(vArray,0)
    factorObj.i = CkJsonArray::ckObjectAt(vArray,0)
    CkJsonObject::ckAppendString(factorObj,"name","remote_address")
    CkJsonObject::ckAppendString(factorObj,"value","127.0.0.1")
    CkJsonObject::ckDispose(factorObj)

    CkJsonArray::ckDispose(vArray)

    CkJsonObject::ckDispose(vFactors)

    ; Use the JSON for the HTTP request body
    ; By default, the Emit method will output compact JSON.
    ; This is best for generating the smallest size request.
    ; To generate a more human-readable (pretty-printed) JSON request body,
    ; set the EmitCompact property to FALSE
    CkJsonObject::setCkEmitCompact(json, 0)
    CkHttpRequest::ckLoadBodyFromString(req,CkJsonObject::ckEmit(json),"utf-8")

    ; View the request that would be sent if SynchronousRequest was called:
    requestMime.s = CkHttpRequest::ckGenerateRequestText(req)
    Debug requestMime

    ; A few important comments about the HTTP request that is generated:
    ; 
    ; 1) The Content-Length header is automatically generated based on the actual length of the MIME message
    ;    that follows the intial (topmost) MIME header.
    ; 2) The HOST header will automatically get filled in with the actual domain when SynchronousRequest
    ;    is called


    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure