(PureBasic) HTTP Verb - How to use any Verb (GET, PUT, POST, DELETE, PROPFIND, etc.)

The HttpVerb property may be set to anything. Typically, it is set to the common/standard HTTP verbs such as GET, POST, PUT, DELETE, etc. It can be set to anything, including custom verbs that only have meaning to your particular server-side application.

This example demonstrates how to compose an HTTP request using the PROPFIND verb, which is something one might use with a WebDAV request.

This example composes the following HTTP request:

   PROPFIND  /container/ HTTP/1.1
   Host: www.foo.bar
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   <?xml version="1.0" encoding="utf-8" ?>
   <D:propfind xmlns:D="DAV:">
     <D:allprop/>
   </D:propfind>

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpRequest.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

    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, "PROPFIND")
    CkHttpRequest::setCkPath(req, "/container/")
    CkHttpRequest::setCkContentType(req, "text/xml")
    CkHttpRequest::setCkCharset(req, "utf-8")
    CkHttpRequest::setCkSendCharset(req, 1)

    CkHttpRequest::ckAddHeader(req,"Depth","1")

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

    CkXml::setCkTag(xml, "propfind")
    CkXml::ckAddAttribute(xml,"xmlns:D","DAV:")
    CkXml::ckNewChild2(xml,"allprop","")

    CkHttpRequest::ckLoadBodyFromString(req,CkXml::ckGetXml(xml),"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)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure