Lianja

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. Lianja

llSuccess = .F.

// 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>'

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

loCurl = createobject("CkHttpCurl")

// 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"
loCurl.SetVar("customer_name","John & Sons")
loCurl.SetVar("note",'He said "Ship it ASAP!"')
loCurl.SetVar("address","123 <Main> Street")
loCurl.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.
loSbRawRequest = createobject("CkStringBuilder")
llSuccess = loCurl.ToRawRequest(loSbCurl.GetAsString(),loSbRawRequest)
if (llSuccess = .F.) then
    ? loCurl.LastErrorText
    release loSbCurl
    release loCurl
    release loSbRawRequest
    return
endif

? loSbRawRequest.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>


release loSbCurl
release loCurl
release loSbRawRequest