EZService Web Service

EZService

Click here for a complete list of operations.

GetUserPaymentsForWeek

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /EZService.asmx HTTP/1.1
Host: ezservice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ezservice.co.uk/api/GetUserPaymentsForWeek"

<?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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserPaymentsForWeek xmlns="http://ezservice.co.uk/api/">
      <username>string</username>
      <password>string</password>
      <startOfWeek>string</startOfWeek>
    </GetUserPaymentsForWeek>
  </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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserPaymentsForWeekResponse xmlns="http://ezservice.co.uk/api/">
      <GetUserPaymentsForWeekResult>
        <Payment>
          <Id>int</Id>
          <Username>string</Username>
          <Amount>decimal</Amount>
          <TransactionCode>string</TransactionCode>
          <GatewayTxCode>string</GatewayTxCode>
          <CostToVendor>decimal</CostToVendor>
          <CostFromGateway>decimal</CostFromGateway>
          <NoOfTransactions>int</NoOfTransactions>
          <NoOfLines>int</NoOfLines>
          <TransactionDate>dateTime</TransactionDate>
          <Successful>boolean</Successful>
          <ErrorMessage>string</ErrorMessage>
        </Payment>
        <Payment>
          <Id>int</Id>
          <Username>string</Username>
          <Amount>decimal</Amount>
          <TransactionCode>string</TransactionCode>
          <GatewayTxCode>string</GatewayTxCode>
          <CostToVendor>decimal</CostToVendor>
          <CostFromGateway>decimal</CostFromGateway>
          <NoOfTransactions>int</NoOfTransactions>
          <NoOfLines>int</NoOfLines>
          <TransactionDate>dateTime</TransactionDate>
          <Successful>boolean</Successful>
          <ErrorMessage>string</ErrorMessage>
        </Payment>
      </GetUserPaymentsForWeekResult>
    </GetUserPaymentsForWeekResponse>
  </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 /EZService.asmx HTTP/1.1
Host: ezservice.co.uk
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:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserPaymentsForWeek xmlns="http://ezservice.co.uk/api/">
      <username>string</username>
      <password>string</password>
      <startOfWeek>string</startOfWeek>
    </GetUserPaymentsForWeek>
  </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:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserPaymentsForWeekResponse xmlns="http://ezservice.co.uk/api/">
      <GetUserPaymentsForWeekResult>
        <Payment>
          <Id>int</Id>
          <Username>string</Username>
          <Amount>decimal</Amount>
          <TransactionCode>string</TransactionCode>
          <GatewayTxCode>string</GatewayTxCode>
          <CostToVendor>decimal</CostToVendor>
          <CostFromGateway>decimal</CostFromGateway>
          <NoOfTransactions>int</NoOfTransactions>
          <NoOfLines>int</NoOfLines>
          <TransactionDate>dateTime</TransactionDate>
          <Successful>boolean</Successful>
          <ErrorMessage>string</ErrorMessage>
        </Payment>
        <Payment>
          <Id>int</Id>
          <Username>string</Username>
          <Amount>decimal</Amount>
          <TransactionCode>string</TransactionCode>
          <GatewayTxCode>string</GatewayTxCode>
          <CostToVendor>decimal</CostToVendor>
          <CostFromGateway>decimal</CostFromGateway>
          <NoOfTransactions>int</NoOfTransactions>
          <NoOfLines>int</NoOfLines>
          <TransactionDate>dateTime</TransactionDate>
          <Successful>boolean</Successful>
          <ErrorMessage>string</ErrorMessage>
        </Payment>
      </GetUserPaymentsForWeekResult>
    </GetUserPaymentsForWeekResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /EZService.asmx/GetUserPaymentsForWeek?username=string&password=string&startOfWeek=string HTTP/1.1
Host: ezservice.co.uk

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPayment xmlns="http://ezservice.co.uk/api/">
  <Payment>
    <Id>int</Id>
    <Username>string</Username>
    <Amount>decimal</Amount>
    <TransactionCode>string</TransactionCode>
    <GatewayTxCode>string</GatewayTxCode>
    <CostToVendor>decimal</CostToVendor>
    <CostFromGateway>decimal</CostFromGateway>
    <NoOfTransactions>int</NoOfTransactions>
    <NoOfLines>int</NoOfLines>
    <TransactionDate>dateTime</TransactionDate>
    <Successful>boolean</Successful>
    <ErrorMessage>string</ErrorMessage>
  </Payment>
  <Payment>
    <Id>int</Id>
    <Username>string</Username>
    <Amount>decimal</Amount>
    <TransactionCode>string</TransactionCode>
    <GatewayTxCode>string</GatewayTxCode>
    <CostToVendor>decimal</CostToVendor>
    <CostFromGateway>decimal</CostFromGateway>
    <NoOfTransactions>int</NoOfTransactions>
    <NoOfLines>int</NoOfLines>
    <TransactionDate>dateTime</TransactionDate>
    <Successful>boolean</Successful>
    <ErrorMessage>string</ErrorMessage>
  </Payment>
</ArrayOfPayment>

HTTP POST

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

POST /EZService.asmx/GetUserPaymentsForWeek HTTP/1.1
Host: ezservice.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&startOfWeek=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPayment xmlns="http://ezservice.co.uk/api/">
  <Payment>
    <Id>int</Id>
    <Username>string</Username>
    <Amount>decimal</Amount>
    <TransactionCode>string</TransactionCode>
    <GatewayTxCode>string</GatewayTxCode>
    <CostToVendor>decimal</CostToVendor>
    <CostFromGateway>decimal</CostFromGateway>
    <NoOfTransactions>int</NoOfTransactions>
    <NoOfLines>int</NoOfLines>
    <TransactionDate>dateTime</TransactionDate>
    <Successful>boolean</Successful>
    <ErrorMessage>string</ErrorMessage>
  </Payment>
  <Payment>
    <Id>int</Id>
    <Username>string</Username>
    <Amount>decimal</Amount>
    <TransactionCode>string</TransactionCode>
    <GatewayTxCode>string</GatewayTxCode>
    <CostToVendor>decimal</CostToVendor>
    <CostFromGateway>decimal</CostFromGateway>
    <NoOfTransactions>int</NoOfTransactions>
    <NoOfLines>int</NoOfLines>
    <TransactionDate>dateTime</TransactionDate>
    <Successful>boolean</Successful>
    <ErrorMessage>string</ErrorMessage>
  </Payment>
</ArrayOfPayment>

Parameter	Value
username:
password:
startOfWeek: