Xbase++ Requires Chilkat v11.5.0+

curl with Variable Substitution in an XML Request Body

See more CURL Examples

This example shows how to use variables inside an XML request body using the {{variable_name}} syntax. When the HTTP request’s Content-Type indicates XML, Chilkat automatically applies proper XML entity encoding to each substituted value, ensuring the resulting XML remains valid. Xbase++

LOCAL nSuccess
LOCAL oSbCurl
LOCAL oCurl
LOCAL oSbRawRequest

nSuccess := 0

//  Variable names are enclosed between {{ and }}

//  curl -X POST https://api.example.com/api/orders \
//    -H "Content-Type: application/xml; charset=utf-8" \
//    -H "Accept: application/xml" \
//    -d '<order>
//    <customerName>{{customer_name}}</customerName>
//    <note>{{note}}</note>
//    <address>{{address}}</address>
//    <instructions>{{instructions}}</instructions>
//  </order>'

oSbCurl := CreateObject("Chilkat.StringBuilder")
oSbCurl:AppendLn("curl -X POST https://api.example.com/api/orders \")
oSbCurl:AppendLn('  -H "Content-Type: application/xml; charset=utf-8" \')
oSbCurl:AppendLn('  -H "Accept: application/xml" \')
oSbCurl:AppendLn("  -d '<order>")
oSbCurl:AppendLn("  <customerName>{{customer_name}}</customerName>")
oSbCurl:AppendLn("  <note>{{note}}</note>")
oSbCurl:AppendLn("  <address>{{address}}</address>")
oSbCurl:AppendLn("  <instructions>{{instructions}}</instructions>")
oSbCurl:AppendLn("</order>'")

oCurl := CreateObject("Chilkat.HttpCurl")

//  The values below contain chars that will require XML entity encoding.  
//  Chilkat will automatically do the encoding because the Content-Type of this request is "application/xml"
oCurl:SetVar("customer_name", "John & Sons")
oCurl:SetVar("note", 'He said "Ship it ASAP!"')
oCurl:SetVar("address", "123 <Main> Street")
oCurl:SetVar("instructions", "Use door #2 & call upon arrival")

//  To demonstrate how the variables are replaced, this example does not execute the curl command. 
//  Instead, it generates the raw HTTP request that would be sent if the curl command were run.
oSbRawRequest := CreateObject("Chilkat.StringBuilder")
nSuccess := oCurl:ToRawRequest(oSbCurl:GetAsString(), oSbRawRequest)
IF (nSuccess == 0)
    ? oCurl:LastErrorText
    oSbCurl:destroy()
    oCurl:destroy()
    oSbRawRequest:destroy()
    RETURN
ENDIF

? oSbRawRequest:GetAsString()

//  The output is shown below.
//  Notice the chars that were XML entity encoded.

//  POST /api/orders HTTP/1.1
//  Accept: application/xml
//  Host: api.example.com
//  Content-Type: application/xml; charset=utf-8
//  Content-Length: 229
//  
//  <order>
//    <customerName>John &amp; Sons</customerName>
//    <note>He said &quot;Ship it ASAP!&quot;</note>
//    <address>123 &lt;Main&gt; Street</address>
//    <instructions>Use door #2 &amp; call upon arrival</instructions>
//  </order>

oSbCurl:destroy()
oCurl:destroy()
oSbRawRequest:destroy()