EZService Web Service

EZService

Click here for a complete list of operations.

GetUserTransactions

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/GetUserTransactions"

<?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>
    <GetUserTransactions xmlns="http://ezservice.co.uk/api/">
      <username>string</username>
      <password>string</password>
    </GetUserTransactions>
  </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>
    <GetUserTransactionsResponse xmlns="http://ezservice.co.uk/api/">
      <GetUserTransactionsResult>
        <SalesTransaction>
          <TransID>long</TransID>
          <FamilyID>long</FamilyID>
          <Amount>decimal</Amount>
          <AmountPaid>decimal</AmountPaid>
          <Balance>decimal</Balance>
          <DatePaid>dateTime</DatePaid>
          <SchoolID>long</SchoolID>
          <ProductID>long</ProductID>
          <SelectionID>long</SelectionID>
          <TransactionType>int</TransactionType>
          <Allocated>boolean</Allocated>
          <ChildName>string</ChildName>
          <StartOfWeek>dateTime</StartOfWeek>
          <TransactionCode>string</TransactionCode>
        </SalesTransaction>
        <SalesTransaction>
          <TransID>long</TransID>
          <FamilyID>long</FamilyID>
          <Amount>decimal</Amount>
          <AmountPaid>decimal</AmountPaid>
          <Balance>decimal</Balance>
          <DatePaid>dateTime</DatePaid>
          <SchoolID>long</SchoolID>
          <ProductID>long</ProductID>
          <SelectionID>long</SelectionID>
          <TransactionType>int</TransactionType>
          <Allocated>boolean</Allocated>
          <ChildName>string</ChildName>
          <StartOfWeek>dateTime</StartOfWeek>
          <TransactionCode>string</TransactionCode>
        </SalesTransaction>
      </GetUserTransactionsResult>
    </GetUserTransactionsResponse>
  </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>
    <GetUserTransactions xmlns="http://ezservice.co.uk/api/">
      <username>string</username>
      <password>string</password>
    </GetUserTransactions>
  </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>
    <GetUserTransactionsResponse xmlns="http://ezservice.co.uk/api/">
      <GetUserTransactionsResult>
        <SalesTransaction>
          <TransID>long</TransID>
          <FamilyID>long</FamilyID>
          <Amount>decimal</Amount>
          <AmountPaid>decimal</AmountPaid>
          <Balance>decimal</Balance>
          <DatePaid>dateTime</DatePaid>
          <SchoolID>long</SchoolID>
          <ProductID>long</ProductID>
          <SelectionID>long</SelectionID>
          <TransactionType>int</TransactionType>
          <Allocated>boolean</Allocated>
          <ChildName>string</ChildName>
          <StartOfWeek>dateTime</StartOfWeek>
          <TransactionCode>string</TransactionCode>
        </SalesTransaction>
        <SalesTransaction>
          <TransID>long</TransID>
          <FamilyID>long</FamilyID>
          <Amount>decimal</Amount>
          <AmountPaid>decimal</AmountPaid>
          <Balance>decimal</Balance>
          <DatePaid>dateTime</DatePaid>
          <SchoolID>long</SchoolID>
          <ProductID>long</ProductID>
          <SelectionID>long</SelectionID>
          <TransactionType>int</TransactionType>
          <Allocated>boolean</Allocated>
          <ChildName>string</ChildName>
          <StartOfWeek>dateTime</StartOfWeek>
          <TransactionCode>string</TransactionCode>
        </SalesTransaction>
      </GetUserTransactionsResult>
    </GetUserTransactionsResponse>
  </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/GetUserTransactions?username=string&password=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"?>
<ArrayOfSalesTransaction xmlns="http://ezservice.co.uk/api/">
  <SalesTransaction>
    <TransID>long</TransID>
    <FamilyID>long</FamilyID>
    <Amount>decimal</Amount>
    <AmountPaid>decimal</AmountPaid>
    <Balance>decimal</Balance>
    <DatePaid>dateTime</DatePaid>
    <SchoolID>long</SchoolID>
    <ProductID>long</ProductID>
    <SelectionID>long</SelectionID>
    <TransactionType>int</TransactionType>
    <Allocated>boolean</Allocated>
    <ChildName>string</ChildName>
    <StartOfWeek>dateTime</StartOfWeek>
    <TransactionCode>string</TransactionCode>
  </SalesTransaction>
  <SalesTransaction>
    <TransID>long</TransID>
    <FamilyID>long</FamilyID>
    <Amount>decimal</Amount>
    <AmountPaid>decimal</AmountPaid>
    <Balance>decimal</Balance>
    <DatePaid>dateTime</DatePaid>
    <SchoolID>long</SchoolID>
    <ProductID>long</ProductID>
    <SelectionID>long</SelectionID>
    <TransactionType>int</TransactionType>
    <Allocated>boolean</Allocated>
    <ChildName>string</ChildName>
    <StartOfWeek>dateTime</StartOfWeek>
    <TransactionCode>string</TransactionCode>
  </SalesTransaction>
</ArrayOfSalesTransaction>

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/GetUserTransactions HTTP/1.1
Host: ezservice.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSalesTransaction xmlns="http://ezservice.co.uk/api/">
  <SalesTransaction>
    <TransID>long</TransID>
    <FamilyID>long</FamilyID>
    <Amount>decimal</Amount>
    <AmountPaid>decimal</AmountPaid>
    <Balance>decimal</Balance>
    <DatePaid>dateTime</DatePaid>
    <SchoolID>long</SchoolID>
    <ProductID>long</ProductID>
    <SelectionID>long</SelectionID>
    <TransactionType>int</TransactionType>
    <Allocated>boolean</Allocated>
    <ChildName>string</ChildName>
    <StartOfWeek>dateTime</StartOfWeek>
    <TransactionCode>string</TransactionCode>
  </SalesTransaction>
  <SalesTransaction>
    <TransID>long</TransID>
    <FamilyID>long</FamilyID>
    <Amount>decimal</Amount>
    <AmountPaid>decimal</AmountPaid>
    <Balance>decimal</Balance>
    <DatePaid>dateTime</DatePaid>
    <SchoolID>long</SchoolID>
    <ProductID>long</ProductID>
    <SelectionID>long</SelectionID>
    <TransactionType>int</TransactionType>
    <Allocated>boolean</Allocated>
    <ChildName>string</ChildName>
    <StartOfWeek>dateTime</StartOfWeek>
    <TransactionCode>string</TransactionCode>
  </SalesTransaction>
</ArrayOfSalesTransaction>

Parameter	Value
username:
password: