TransactionsQuery Web Service

TransactionsQuery

Click here for a complete list of operations.

GetTransactionsAllSince

Test

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

Parameter	Value
login:
password:
startDate:
includeFailedTransactions:
includeNonMembers:
includeTransactionDetails:
includeUnreviewed:
filter:

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 /ws/21/TransactionsQuery.asmx HTTP/1.1
Host: api.imodules.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://imodules.com/WebServices/TransactionsQuery/GetTransactionsAllSince"

<?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>
    <GetTransactionsAllSince xmlns="http://imodules.com/WebServices/TransactionsQuery/">
      <login>string</login>
      <password>string</password>
      <startDate>dateTime</startDate>
      <includeFailedTransactions>boolean</includeFailedTransactions>
      <includeNonMembers>boolean</includeNonMembers>
      <includeTransactionDetails>boolean</includeTransactionDetails>
      <includeUnreviewed>boolean</includeUnreviewed>
      <filter>string</filter>
    </GetTransactionsAllSince>
  </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>
    <GetTransactionsAllSinceResponse xmlns="http://imodules.com/WebServices/TransactionsQuery/">
      <GetTransactionsAllSinceResult>
        <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <TransactionItems>
            <TransactionItem xsi:nil="true" />
            <TransactionItem xsi:nil="true" />
          </TransactionItems>
          <LinkedTransaction>
            <TransactionId>int</TransactionId>
            <Amount>decimal</Amount>
            <ControlId>int</ControlId>
            <ControlType>string</ControlType>
            <ControlName>string</ControlName>
            <PaymentType>string</PaymentType>
            <TotalScheduledAmount>decimal</TotalScheduledAmount>
          </LinkedTransaction>
          <LedgerValues>
            <LedgerValue xsi:nil="true" />
            <LedgerValue xsi:nil="true" />
          </LedgerValues>
        </Transaction>
        <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <TransactionItems>
            <TransactionItem xsi:nil="true" />
            <TransactionItem xsi:nil="true" />
          </TransactionItems>
          <LinkedTransaction>
            <TransactionId>int</TransactionId>
            <Amount>decimal</Amount>
            <ControlId>int</ControlId>
            <ControlType>string</ControlType>
            <ControlName>string</ControlName>
            <PaymentType>string</PaymentType>
            <TotalScheduledAmount>decimal</TotalScheduledAmount>
          </LinkedTransaction>
          <LedgerValues>
            <LedgerValue xsi:nil="true" />
            <LedgerValue xsi:nil="true" />
          </LedgerValues>
        </Transaction>
        <Error Code="int" Description="string" />
      </GetTransactionsAllSinceResult>
    </GetTransactionsAllSinceResponse>
  </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 /ws/21/TransactionsQuery.asmx HTTP/1.1
Host: api.imodules.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:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTransactionsAllSince xmlns="http://imodules.com/WebServices/TransactionsQuery/">
      <login>string</login>
      <password>string</password>
      <startDate>dateTime</startDate>
      <includeFailedTransactions>boolean</includeFailedTransactions>
      <includeNonMembers>boolean</includeNonMembers>
      <includeTransactionDetails>boolean</includeTransactionDetails>
      <includeUnreviewed>boolean</includeUnreviewed>
      <filter>string</filter>
    </GetTransactionsAllSince>
  </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>
    <GetTransactionsAllSinceResponse xmlns="http://imodules.com/WebServices/TransactionsQuery/">
      <GetTransactionsAllSinceResult>
        <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <TransactionItems>
            <TransactionItem xsi:nil="true" />
            <TransactionItem xsi:nil="true" />
          </TransactionItems>
          <LinkedTransaction>
            <TransactionId>int</TransactionId>
            <Amount>decimal</Amount>
            <ControlId>int</ControlId>
            <ControlType>string</ControlType>
            <ControlName>string</ControlName>
            <PaymentType>string</PaymentType>
            <TotalScheduledAmount>decimal</TotalScheduledAmount>
          </LinkedTransaction>
          <LedgerValues>
            <LedgerValue xsi:nil="true" />
            <LedgerValue xsi:nil="true" />
          </LedgerValues>
        </Transaction>
        <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <Column Name="string" Value="string">
            <Designations xsi:nil="true" />
          </Column>
          <TransactionItems>
            <TransactionItem xsi:nil="true" />
            <TransactionItem xsi:nil="true" />
          </TransactionItems>
          <LinkedTransaction>
            <TransactionId>int</TransactionId>
            <Amount>decimal</Amount>
            <ControlId>int</ControlId>
            <ControlType>string</ControlType>
            <ControlName>string</ControlName>
            <PaymentType>string</PaymentType>
            <TotalScheduledAmount>decimal</TotalScheduledAmount>
          </LinkedTransaction>
          <LedgerValues>
            <LedgerValue xsi:nil="true" />
            <LedgerValue xsi:nil="true" />
          </LedgerValues>
        </Transaction>
        <Error Code="int" Description="string" />
      </GetTransactionsAllSinceResult>
    </GetTransactionsAllSinceResponse>
  </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 /ws/21/TransactionsQuery.asmx/GetTransactionsAllSince?login=string&password=string&startDate=string&includeFailedTransactions=string&includeNonMembers=string&includeTransactionDetails=string&includeUnreviewed=string&filter=string HTTP/1.1
Host: api.imodules.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTransactions xmlns="http://imodules.com/WebServices/TransactionsQuery/">
  <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <TransactionItems>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
    </TransactionItems>
    <LinkedTransaction>
      <TransactionId>int</TransactionId>
      <Amount>decimal</Amount>
      <ControlId>int</ControlId>
      <ControlType>string</ControlType>
      <ControlName>string</ControlName>
      <PaymentType>string</PaymentType>
      <TotalScheduledAmount>decimal</TotalScheduledAmount>
    </LinkedTransaction>
    <LedgerValues>
      <LedgerValue Name="string" Value="string" />
      <LedgerValue Name="string" Value="string" />
    </LedgerValues>
  </Transaction>
  <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <TransactionItems>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
    </TransactionItems>
    <LinkedTransaction>
      <TransactionId>int</TransactionId>
      <Amount>decimal</Amount>
      <ControlId>int</ControlId>
      <ControlType>string</ControlType>
      <ControlName>string</ControlName>
      <PaymentType>string</PaymentType>
      <TotalScheduledAmount>decimal</TotalScheduledAmount>
    </LinkedTransaction>
    <LedgerValues>
      <LedgerValue Name="string" Value="string" />
      <LedgerValue Name="string" Value="string" />
    </LedgerValues>
  </Transaction>
  <Error Code="int" Description="string" />
</ArrayOfTransactions>

HTTP POST

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

POST /ws/21/TransactionsQuery.asmx/GetTransactionsAllSince HTTP/1.1
Host: api.imodules.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

login=string&password=string&startDate=string&includeFailedTransactions=string&includeNonMembers=string&includeTransactionDetails=string&includeUnreviewed=string&filter=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTransactions xmlns="http://imodules.com/WebServices/TransactionsQuery/">
  <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <TransactionItems>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
    </TransactionItems>
    <LinkedTransaction>
      <TransactionId>int</TransactionId>
      <Amount>decimal</Amount>
      <ControlId>int</ControlId>
      <ControlType>string</ControlType>
      <ControlName>string</ControlName>
      <PaymentType>string</PaymentType>
      <TotalScheduledAmount>decimal</TotalScheduledAmount>
    </LinkedTransaction>
    <LedgerValues>
      <LedgerValue Name="string" Value="string" />
      <LedgerValue Name="string" Value="string" />
    </LedgerValues>
  </Transaction>
  <Transaction Transaction_Id="int" IsSuccess="boolean" IsReviewed="boolean">
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <Column Name="string" Value="string">
      <Designations>
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Designation d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Designations>
    </Column>
    <TransactionItems>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
      <TransactionItem Imod_Member_Id="int" Type="string" Transaction_Item_Id="string">
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Column d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </TransactionItem>
    </TransactionItems>
    <LinkedTransaction>
      <TransactionId>int</TransactionId>
      <Amount>decimal</Amount>
      <ControlId>int</ControlId>
      <ControlType>string</ControlType>
      <ControlName>string</ControlName>
      <PaymentType>string</PaymentType>
      <TotalScheduledAmount>decimal</TotalScheduledAmount>
    </LinkedTransaction>
    <LedgerValues>
      <LedgerValue Name="string" Value="string" />
      <LedgerValue Name="string" Value="string" />
    </LedgerValues>
  </Transaction>
  <Error Code="int" Description="string" />
</ArrayOfTransactions>