Difference between revisions of "Web Services Example - queryReport"

From SmartWiki
Jump to: navigation, search
(Created page with "The following are sample SOAP messages that will query SmartSimple to run a report and return the results in an XML format. This example applies to the following: SmartSimple...")
 
m
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
This example applies to the following:
 
This example applies to the following:
−
SmartSimple site: https://smart.smartsimple.com
+
* SmartSimple site: https://smart.smartsimple.com
−
Web Service User: user@smartsimple.com
+
* Web Service User: user@smartsimple.com
−
Web Service Password: password
+
* Web Service Password: password
  
−
Sample #1
+
==Sample #1==
−
Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
+
Run a simple report that does not prompt for criteria.
−
Action: http://uta.WS.SmartSimple2.com/queryReport
+
* Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
−
ReportID: 12345
+
* Action: http://uta.WS.SmartSimple2.com/queryReport
−
Note: Report 12345 does not prompt for dynamic run-time criteria
+
* ReportID: 12345 (Note: Report 12345 does not prompt for dynamic run-time criteria)
  
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com">   <soapenv:Header/>   <soapenv:Body>     <uta:queryReport>         <uta:alias>smart</uta:alias>         <uta:username>user@smartsimple.com</uta:username>         <uta:password>password</uta:password>         <uta:reportid>12345</uta:reportid>         <!--Optional:-->         <uta:criteria></uta:criteria>     </uta:queryReport>   </soapenv:Body></soapenv:Envelope>
+
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:uta="http://uta.WS.SmartSimple2.com">
 +
<soapenv:Header/>
 +
<soapenv:Body>
 +
<uta:queryReport>
 +
<uta:alias>smart</uta:alias>
 +
<uta:username>user@smartsimple.com</uta:username>
 +
<uta:password>password</uta:password>
 +
<uta:reportid>12345</uta:reportid>
 +
<!--Optional:-->
 +
<uta:criteria></uta:criteria>
 +
</uta:queryReport>
 +
</soapenv:Body>
 +
</soapenv:Envelope>
  
 +
==Sample #2==
 +
Run a simple report that does not prompt for criteria, but we wish to add our own dynamic run-time criteria.
 +
* Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
 +
* Action: http://uta.WS.SmartSimple2.com/queryReport
 +
* ReportID: 12345 (Note: Report 12345 does not prompt for dynamic run-time criteria)
  
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com">
 +
<soapenv:Header/>
 +
<soapenv:Body>
 +
<uta:queryReport>
 +
<uta:alias>smart</uta:alias>
 +
<uta:username>user@smartsimple.com</uta:username>
 +
<uta:password>password</uta:password>
 +
<uta:reportid>12345</uta:reportid>
 +
<!--Optional:-->
 +
<uta:criteria>$$column 1 = "criteria 1" and column 2 = "criteria 2"</uta:criteria>
 +
</uta:queryReport>
 +
</soapenv:Body>
 +
</soapenv:Envelope>
  
−
Sample #2
+
==Sample #3==
−
Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
+
Run a simple report that does prompt for criteria.
−
Action: http://uta.WS.SmartSimple2.com/queryReport
+
* Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
−
ReportID: 12345
+
* Action: http://uta.WS.SmartSimple2.com/queryReport
−
Note: Report 12345 does not prompt for dynamic run-time criteria
+
* ReportID: 67890 (Note: Report 67890 prompts for dynamic run-time criteria)
  
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com">   <soapenv:Header/>   <soapenv:Body>     <uta:queryReport>         <uta:alias>smart</uta:alias>         <uta:username>user@smartsimple.com</uta:username>         <uta:password>password</uta:password>         <uta:reportid>12345</uta:reportid>         <!--Optional:-->         <uta:criteria>$$column 1 = "criteria 1" and column 2 = "criteria 2"</uta:criteria>     </uta:queryReport>   </soapenv:Body></soapenv:Envelope>
+
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com">
 +
<soapenv:Header/>
 +
<soapenv:Body>
 +
<uta:queryReport>
 +
<uta:alias>smart</uta:alias>
 +
<uta:username>user@smartsimple.com</uta:username>
 +
<uta:password>password</uta:password>
 +
<uta:reportid>67890</uta:reportid>
 +
<!--Optional:-->
 +
<uta:criteria>criteria 1;;criteria 2</uta:criteria>
 +
</uta:queryReport>
 +
</soapenv:Body>
 +
</soapenv:Envelope>
  
  
−
 
+
[[Category:Web Services]]
−
Sample #3
 
−
Endpoint: https://smart.smartsimple.com/WS/services/UtaUpdate
 
−
Action: http://uta.WS.SmartSimple2.com/queryReport
 
−
ReportID: 67890
 
−
Note: Report 67890 prompts for dynamic run-time criteria
 
−
 
 
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com">  <soapenv:Header/>  <soapenv:Body>      <uta:queryReport>        <uta:alias>smart</uta:alias>        <uta:username>user@smartsimple.com</uta:username>        <uta:password>password</uta:password>        <uta:reportid>67890</uta:reportid>        <!--Optional:-->        <uta:criteria>"criteria 1";;"criteria 2"</uta:criteria>      </uta:queryReport>  </soapenv:Body></soapenv:Envelope>
 

Latest revision as of 10:05, 6 February 2015

The following are sample SOAP messages that will query SmartSimple to run a report and return the results in an XML format.

This example applies to the following:

Sample #1

Run a simple report that does not prompt for criteria.

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:uta="http://uta.WS.SmartSimple2.com"> <soapenv:Header/> <soapenv:Body> <uta:queryReport> <uta:alias>smart</uta:alias> <uta:username>user@smartsimple.com</uta:username> <uta:password>password</uta:password> <uta:reportid>12345</uta:reportid> <uta:criteria></uta:criteria> </uta:queryReport> </soapenv:Body> </soapenv:Envelope>

Sample #2

Run a simple report that does not prompt for criteria, but we wish to add our own dynamic run-time criteria.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com"> <soapenv:Header/> <soapenv:Body> <uta:queryReport> <uta:alias>smart</uta:alias> <uta:username>user@smartsimple.com</uta:username> <uta:password>password</uta:password> <uta:reportid>12345</uta:reportid> <uta:criteria>$$column 1 = "criteria 1" and column 2 = "criteria 2"</uta:criteria> </uta:queryReport> </soapenv:Body> </soapenv:Envelope>

Sample #3

Run a simple report that does prompt for criteria.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uta="http://uta.WS.SmartSimple2.com"> <soapenv:Header/> <soapenv:Body> <uta:queryReport> <uta:alias>smart</uta:alias> <uta:username>user@smartsimple.com</uta:username> <uta:password>password</uta:password> <uta:reportid>67890</uta:reportid> <uta:criteria>criteria 1;;criteria 2</uta:criteria> </uta:queryReport> </soapenv:Body> </soapenv:Envelope>

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Web_Services_Example_-_queryReport&oldid=24072’