(Tcl) Peoplevox SaveData

Demonstrates how to call the Peoplevox SaveData SOAP method. This example adds a new carrier (DHL) to the system.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Sends a POST that looks like this:

# 	POST /PEOPLEVOX_CLIENT_ID/resources/integrationservicev4.asmx HTTP/1.1
# 	Content-Type: text/xml;charset=UTF-8
# 	SOAPAction: http://www.peoplevox.net/SaveData
# 	Content-Length: (automatically computed and added by Chilkat)
# 	Host: qac.peoplevox.net
# 
# 	<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:peop="http://www.peoplevox.net/">
# 	   <soap:Header>
# 	      <peop:UserSessionCredentials>
# 	         <peop:UserId>PEOPLEVOX_USER_ID</peop:UserId>
# 	         <peop:ClientId>PEOPLEVOX_CLIENT_ID</peop:ClientId>
# 	         <peop:SessionId>PEOPLEVOX_SESSION_ID</peop:SessionId>
# 	      </peop:UserSessionCredentials>
# 	   </soap:Header>
#         <soap:Body>
#           <peop:SaveData>
#              <peop:saveRequest>
#                 <peop:TemplateName>Carriers</peop:TemplateName>
#                 <peop:CsvData>CSV_DATA</peop:CsvData>
#                 <peop:Action>0</peop:Action>
#              </peop:saveRequest>
#           </peop:SaveData>
#        </soap:Body>
# 	</soap:Envelope>
# 

# Notice that a UserId is needed here.  This is different than the username required for Peoplevox authentication.
#    The UserId for the admin account is 1.
#     
set sbSoapXml [new_CkStringBuilder]

CkStringBuilder_Append $sbSoapXml "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n"
CkStringBuilder_Append $sbSoapXml "<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:peop=\"http://www.peoplevox.net/\">\r\n"
CkStringBuilder_Append $sbSoapXml "   <soap:Header>\r\n"
CkStringBuilder_Append $sbSoapXml "      <peop:UserSessionCredentials>\r\n"
CkStringBuilder_Append $sbSoapXml "         <peop:UserId>PEOPLEVOX_USER_ID</peop:UserId>\r\n"
CkStringBuilder_Append $sbSoapXml "         <peop:ClientId>PEOPLEVOX_CLIENT_ID</peop:ClientId>\r\n"
CkStringBuilder_Append $sbSoapXml "         <peop:SessionId>PEOPLEVOX_SESSION_ID</peop:SessionId>\r\n"
CkStringBuilder_Append $sbSoapXml "      </peop:UserSessionCredentials>\r\n"
CkStringBuilder_Append $sbSoapXml "   </soap:Header>\r\n"
CkStringBuilder_Append $sbSoapXml "   <soap:Body>\r\n"
CkStringBuilder_Append $sbSoapXml "      <peop:SaveData>\r\n"
CkStringBuilder_Append $sbSoapXml "         <peop:saveRequest>\r\n"
CkStringBuilder_Append $sbSoapXml "            <peop:TemplateName>Carriers</peop:TemplateName>\r\n"
CkStringBuilder_Append $sbSoapXml "            <peop:CsvData>CSV_DATA</peop:CsvData>\r\n"
CkStringBuilder_Append $sbSoapXml "            <peop:Action>0</peop:Action>\r\n"
CkStringBuilder_Append $sbSoapXml "         </peop:saveRequest>\r\n"
CkStringBuilder_Append $sbSoapXml "      </peop:SaveData>\r\n"
CkStringBuilder_Append $sbSoapXml "   </soap:Body>\r\n"
CkStringBuilder_Append $sbSoapXml "</soap:Envelope>"

set sbCsvData [new_CkStringBuilder]

CkStringBuilder_Append $sbCsvData "Name,Reference\r\n"
CkStringBuilder_Append $sbCsvData "DHL,D0001"
set numReplacements [CkStringBuilder_Replace $sbSoapXml "CSV_DATA" [CkStringBuilder_getAsString $sbCsvData]]

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_SendCharset $req 1
CkHttpRequest_put_Charset $req "utf-8"
CkHttpRequest_AddHeader $req "Content-Type" "text/xml"
CkHttpRequest_AddHeader $req "SOAPAction" "http://www.peoplevox.net/SaveData"
CkHttpRequest_put_Path $req "/PEOPLEVOX_CLIENT_ID/resources/integrationservicev4.asmx"
set success [CkHttpRequest_LoadBodyFromString $req [CkStringBuilder_getAsString $sbSoapXml] "utf-8"]

set http [new_CkHttp]

CkHttp_put_FollowRedirects $http 1

# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "qac.peoplevox.net" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sbSoapXml
    delete_CkStringBuilder $sbCsvData
    delete_CkHttpRequest $req
    delete_CkHttp $http
    exit
}

# We should expect a 200 response if successful.
if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Response StatusCode = [CkHttpResponse_get_StatusCode $resp]"
    puts "Response StatusLine: [CkHttpResponse_statusLine $resp]"
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts [CkHttpResponse_bodyStr $resp]
    delete_CkStringBuilder $sbSoapXml
    delete_CkStringBuilder $sbCsvData
    delete_CkHttpRequest $req
    delete_CkHttp $http
    exit
}

set xmlResponse [new_CkXml]

set success [CkXml_LoadXml $xmlResponse [CkHttpResponse_bodyStr $resp]]
puts [CkXml_getXml $xmlResponse]
delete_CkHttpResponse $resp

# A successful response is shown below.
# To parse a successful response:
set reference [CkXml_chilkatPath $xmlResponse "soap:Body|SaveDataResponse|SaveDataResult|Statuses|IntegrationStatusResponse|Reference|*"]
puts "Reference = $reference"
set status [CkXml_chilkatPath $xmlResponse "soap:Body|SaveDataResponse|SaveDataResult|Statuses|IntegrationStatusResponse|Status|*"]
puts "Status = $status"

# <?xml version="1.0" encoding="utf-8" ?>
# <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
#     <soap:Body>
#         <SaveDataResponse xmlns="http://www.peoplevox.net/">
#             <SaveDataResult>
#                 <ResponseId>0</ResponseId>
#                 <TotalCount>1</TotalCount>
#                 <Detail />
#                 <Statuses>
#                     <IntegrationStatusResponse>
#                         <Reference>D0001</Reference>
#                         <Status>Success</Status>
#                         <LineNo>0</LineNo>
#                     </IntegrationStatusResponse>
#                 </Statuses>
#                 <ImportingQueueId>0</ImportingQueueId>
#                 <SalesOrdersToDespatchIds />
#             </SaveDataResult>
#         </SaveDataResponse>
#     </soap:Body>
# </soap:Envelope>

delete_CkStringBuilder $sbSoapXml
delete_CkStringBuilder $sbCsvData
delete_CkHttpRequest $req
delete_CkHttp $http
delete_CkXml $xmlResponse