Description
Returns Partner – Catalog usage report in the form of xml.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetUsageReport |
Name of interface |
|
<sessionid> |
Id |
Id of the active session. |
Parameters
|
<secure> |
Secure |
Security flag. |
|
<archive> |
Archive |
Archive flag. |
|
<fromdate> |
FromDate |
Date to report from - formatted "mm/dd/yyyy" |
|
<todate> |
ToDate |
Date to report to - formatted "mm/dd/yyyy" |
Return Values
|
<success> |
SuccessDescription |
Success Description |
|
<returnval> |
ReturnVal |
Link to the necessary output |
Fault Values
|
<faultcode> |
ErrorNumber |
Error code |
|
<faultstring>
|
Description |
Description of the error |
Remarks
If both the fromdate and the todate are empty (blank) then the entire report will be fetched.
Sample SOAP/XML Request
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Header>
<interfacename>SWGetUsageReport</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<archive>on</archive>
<fromdate>01/01/2000</fromdate>
<todate>11/30/2000</todate>
</interfaceparameters>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample SOAP/XML Success Response
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Header>
<interfacename>SWGetUsageReport</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<success>Success Description</success>
<returnval>Link to the necessary output</returnval>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample SOAP/XML Error Response
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Header>
<interfacename>SWGetUsageReport</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<faultcode>0000</faultcode>
<faultstring>Description</faultstring>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>