(Ruby) Peoplevox SaveData

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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.
#     
sbSoapXml = Chilkat::CkStringBuilder.new()
sbSoapXml.Append("<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n")
sbSoapXml.Append("<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:peop=\"http://www.peoplevox.net/\">\r\n")
sbSoapXml.Append("   <soap:Header>\r\n")
sbSoapXml.Append("      <peop:UserSessionCredentials>\r\n")
sbSoapXml.Append("         <peop:UserId>PEOPLEVOX_USER_ID</peop:UserId>\r\n")
sbSoapXml.Append("         <peop:ClientId>PEOPLEVOX_CLIENT_ID</peop:ClientId>\r\n")
sbSoapXml.Append("         <peop:SessionId>PEOPLEVOX_SESSION_ID</peop:SessionId>\r\n")
sbSoapXml.Append("      </peop:UserSessionCredentials>\r\n")
sbSoapXml.Append("   </soap:Header>\r\n")
sbSoapXml.Append("   <soap:Body>\r\n")
sbSoapXml.Append("      <peop:SaveData>\r\n")
sbSoapXml.Append("         <peop:saveRequest>\r\n")
sbSoapXml.Append("            <peop:TemplateName>Carriers</peop:TemplateName>\r\n")
sbSoapXml.Append("            <peop:CsvData>CSV_DATA</peop:CsvData>\r\n")
sbSoapXml.Append("            <peop:Action>0</peop:Action>\r\n")
sbSoapXml.Append("         </peop:saveRequest>\r\n")
sbSoapXml.Append("      </peop:SaveData>\r\n")
sbSoapXml.Append("   </soap:Body>\r\n")
sbSoapXml.Append("</soap:Envelope>")

sbCsvData = Chilkat::CkStringBuilder.new()
sbCsvData.Append("Name,Reference\r\n")
sbCsvData.Append("DHL,D0001")
numReplacements = sbSoapXml.Replace("CSV_DATA",sbCsvData.getAsString())

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_SendCharset(true)
req.put_Charset("utf-8")
req.AddHeader("Content-Type","text/xml")
req.AddHeader("SOAPAction","http://www.peoplevox.net/SaveData")
req.put_Path("/PEOPLEVOX_CLIENT_ID/resources/integrationservicev4.asmx")
success = req.LoadBodyFromString(sbSoapXml.getAsString(),"utf-8")

http = Chilkat::CkHttp.new()
http.put_FollowRedirects(true)

# resp is a CkHttpResponse
resp = http.SynchronousRequest("qac.peoplevox.net",443,true,req)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (resp.get_StatusCode() != 200)
    print "Response StatusCode = " + resp.get_StatusCode().to_s() + "\n";
    print "Response StatusLine: " + resp.statusLine() + "\n";
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print resp.bodyStr() + "\n";
    exit
end

xmlResponse = Chilkat::CkXml.new()
success = xmlResponse.LoadXml(resp.bodyStr())
print xmlResponse.getXml() + "\n";

# A successful response is shown below.
# To parse a successful response:
reference = xmlResponse.chilkatPath("soap:Body|SaveDataResponse|SaveDataResult|Statuses|IntegrationStatusResponse|Reference|*")
print "Reference = " + reference + "\n";
status = xmlResponse.chilkatPath("soap:Body|SaveDataResponse|SaveDataResult|Statuses|IntegrationStatusResponse|Status|*")
print "Status = " + status + "\n";

# <?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>