Wel Web Service

Click here for a complete list of operations.

RetrieveReport

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservice/service.asmx HTTP/1.1
Host: users.ozmedia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.welcorp.com/webservice/RetrieveReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.welcorp.com/webservice/" xmlns:types="http://www.welcorp.com/webservice/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <tns:AuthenticationHeader>
      <Username xsi:type="xsd:string">string</Username>
      <Password xsi:type="xsd:string">string</Password>
      <Usercode xsi:type="xsd:string">string</Usercode>
    </tns:AuthenticationHeader>
  </soap:Header>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:RetrieveReport>
      <jobId xsi:type="xsd:int">int</jobId>
    </tns:RetrieveReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.welcorp.com/webservice/" xmlns:types="http://www.welcorp.com/webservice/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:RetrieveReportResponse>
      <RetrieveReportResult href="#id1" />
    </tns:RetrieveReportResponse>
    <tns:StatusReport id="id1" xsi:type="tns:StatusReport">
      <JobId xsi:type="xsd:int">int</JobId>
      <Submitted xsi:type="xsd:dateTime">dateTime</Submitted>
      <JobType xsi:type="xsd:string">string</JobType>
      <JobStatus xsi:type="xsd:string">string</JobStatus>
      <TotalRecipients xsi:type="xsd:int">int</TotalRecipients>
      <SentRecipients xsi:type="xsd:int">int</SentRecipients>
      <FailedRecipients xsi:type="xsd:int">int</FailedRecipients>
      <TotalCost xsi:type="xsd:double">double</TotalCost>
      <RelatedJobs xsi:type="xsd:string">string</RelatedJobs>
      <Pages xsi:type="xsd:int">int</Pages>
    </tns:StatusReport>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservice/service.asmx HTTP/1.1
Host: users.ozmedia.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://www.welcorp.com/webservice/" xmlns:types="http://www.welcorp.com/webservice/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <tns:AuthenticationHeader soapenc:id="id0">
      <Username xsi:type="xsd:string">string</Username>
      <Password xsi:type="xsd:string">string</Password>
      <Usercode xsi:type="xsd:string">string</Usercode>
    </tns:AuthenticationHeader>
  </soap12:Header>
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:RetrieveReport>
      <jobId xsi:type="xsd:int">int</jobId>
    </tns:RetrieveReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://www.welcorp.com/webservice/" xmlns:types="http://www.welcorp.com/webservice/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:RetrieveReportResponse>
      <rpc:result xmlns="">RetrieveReportResult</rpc:result>
      <RetrieveReportResult soapenc:id="id0" xsi:type="tns:StatusReport">
        <JobId xsi:type="xsd:int">int</JobId>
        <Submitted xsi:type="xsd:dateTime">dateTime</Submitted>
        <JobType xsi:type="xsd:string">string</JobType>
        <JobStatus xsi:type="xsd:string">string</JobStatus>
        <TotalRecipients xsi:type="xsd:int">int</TotalRecipients>
        <SentRecipients xsi:type="xsd:int">int</SentRecipients>
        <FailedRecipients xsi:type="xsd:int">int</FailedRecipients>
        <TotalCost xsi:type="xsd:double">double</TotalCost>
        <RelatedJobs xsi:type="xsd:string">string</RelatedJobs>
        <Pages xsi:type="xsd:int">int</Pages>
      </RetrieveReportResult>
    </tns:RetrieveReportResponse>
  </soap12:Body>
</soap12:Envelope>