Back to Collection Items
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample XML: Generate Code to Create XML
; The following XML is sent in the request body.
; <?xml version="1.0" encoding="utf-8"?>
; <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://soap.sforce.com/2006/04/metadata">
; <soapenv:Header>
; <tns:SessionHeader>
; <tns:sessionId>{{_accessToken}}</tns:sessionId>
; </tns:SessionHeader>
; </soapenv:Header>
; <soapenv:Body>
; <tns:describeValueType>
; <type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>
; </tns:describeValueType>
; </soapenv:Body>
; </soapenv:Envelope>
;
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "soapenv:Envelope")
CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
CkXml::ckAddAttribute(xml,"xmlns:tns","http://soap.sforce.com/2006/04/metadata")
CkXml::ckUpdateChildContent(xml,"soapenv:Header|tns:SessionHeader|tns:sessionId","{{_accessToken}}")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|tns:describeValueType|type","{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME")
CkHttp::ckSetRequestHeader(http,"Content-Type","text/xml")
CkHttp::ckSetRequestHeader(http,"SOAPAction","login")
CkHttp::ckSetRequestHeader(http,"Accept","text/xml")
CkHttp::ckSetRequestHeader(http,"charset","UTF-8")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckGetXmlSb(xml,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"POST","https://domain.com/services/Soap/m/{{version}}",sbRequestBody,"utf-8","text/xml",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
CkHttpResponse::ckDispose(resp)
xmlResponse.i = CkXml::ckCreate()
If xmlResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckLoadSb(xmlResponse,sbResponseBody,1)
Debug CkXml::ckGetXml(xmlResponse)
; Sample XML response:
; (Sample code for parsing the XML response is shown below)
; <?xml version="1.0" encoding="UTF-8"?>
; <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/2006/04/metadata">
; <soapenv:Body>
; <describeValueTypeResponse>
; <result>
; <apiCreatable>false</apiCreatable>
; <apiDeletable>false</apiDeletable>
; <apiReadable>false</apiReadable>
; <apiUpdatable>false</apiUpdatable>
; </result>
; </describeValueTypeResponse>
; </soapenv:Body>
; </soapenv:Envelope>
; Sample code for parsing the XML response...
; Use this online tool to generate parsing code from sample XML: Generate XML Parsing Code
soapenv_Envelope_xmlns_soapenv.s = CkXml::ckGetAttrValue(xmlResponse,"xmlns:soapenv")
soapenv_Envelope_xmlns.s = CkXml::ckGetAttrValue(xmlResponse,"xmlns")
apiCreatable.s = CkXml::ckGetChildContent(xmlResponse,"soapenv:Body|describeValueTypeResponse|result|apiCreatable")
apiDeletable.s = CkXml::ckGetChildContent(xmlResponse,"soapenv:Body|describeValueTypeResponse|result|apiDeletable")
apiReadable.s = CkXml::ckGetChildContent(xmlResponse,"soapenv:Body|describeValueTypeResponse|result|apiReadable")
apiUpdatable.s = CkXml::ckGetChildContent(xmlResponse,"soapenv:Body|describeValueTypeResponse|result|apiUpdatable")
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkXml::ckDispose(xmlResponse)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: text/xml"
-H "charset: UTF-8"
-H "SOAPAction: login"
-H "Accept: text/xml"
-d '<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://soap.sforce.com/2006/04/metadata">
<soapenv:Header>
<tns:SessionHeader>
<tns:sessionId>{{_accessToken}}</tns:sessionId>
</tns:SessionHeader>
</soapenv:Header>
<soapenv:Body>
<tns:describeValueType>
<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>
</tns:describeValueType>
</soapenv:Body>
</soapenv:Envelope>'
https://domain.com/services/Soap/m/{{version}}
Postman Collection Item JSON
{
"name": "SOAP DescribeValueType",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "text/xml",
"type": "text"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "SOAPAction",
"value": "login"
},
{
"key": "Accept",
"value": "text/xml",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:tns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<soapenv:Header>\n\t<tns:SessionHeader>\n\t\t<tns:sessionId>{{_accessToken}}</tns:sessionId>\n\t</tns:SessionHeader>\n\t</soapenv:Header>\n\t<soapenv:Body>\n\t\t<tns:describeValueType>\n\t\t\t<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>\n\t\t</tns:describeValueType>\n\t</soapenv:Body>\n</soapenv:Envelope>"
},
"url": {
"raw": "{{_endpoint}}/services/Soap/m/{{version}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"Soap",
"m",
"{{version}}"
]
}
},
"response": [
{
"name": "Status200-Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "text/xml"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "SOAPAction",
"value": "login"
},
{
"key": "Accept",
"value": "text/xml"
}
],
"body": {
"mode": "raw",
"raw": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:tns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<soapenv:Header>\n\t<tns:SessionHeader>\n\t\t<tns:sessionId>{{_accessToken}}</tns:sessionId>\n\t</tns:SessionHeader>\n\t</soapenv:Header>\n\t<soapenv:Body>\n\t\t<tns:describeValueType>\n\t\t\t<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>\n\t\t</tns:describeValueType>\n\t</soapenv:Body>\n</soapenv:Envelope>"
},
"url": {
"raw": "{{_endpoint}}/services/Soap/m/{{version}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"Soap",
"m",
"{{version}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "xml",
"header": [
{
"key": "Date",
"value": "Thu, 07 Sep 2023 09:25:45 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "text/xml; charset=utf-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <soapenv:Body>\n <describeValueTypeResponse>\n <result>\n <apiCreatable>false</apiCreatable>\n <apiDeletable>false</apiDeletable>\n <apiReadable>false</apiReadable>\n <apiUpdatable>false</apiUpdatable>\n </result>\n </describeValueTypeResponse>\n </soapenv:Body>\n</soapenv:Envelope>"
}
]
}
