ControlQuery Web Service

ControlQuery

Click here for a complete list of operations.

Update

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

<?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>
    <Update xmlns="http://imodules.com/WebServices/ControlQuery/">
      <login>string</login>
      <password>string</password>
      <controlId>int</controlId>
      <allowAddingConstituents>boolean</allowAddingConstituents>
      <MemberInformation Imod_Member_Id="int" Constituent_Id="string" Last_Updated="dateTime" Last_Updated_By_Constituent_Id="string" Last_Updated_By_Name="string">
        <Guests>
          <Guest IMod_Member_Id="int" />
          <Guest IMod_Member_Id="int" />
        </Guests>
        <GuestOf IMod_Member_Id="int" />
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Instances>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
        </Instances>
      </MemberInformation>
      <MemberInformation Imod_Member_Id="int" Constituent_Id="string" Last_Updated="dateTime" Last_Updated_By_Constituent_Id="string" Last_Updated_By_Name="string">
        <Guests>
          <Guest IMod_Member_Id="int" />
          <Guest IMod_Member_Id="int" />
        </Guests>
        <GuestOf IMod_Member_Id="int" />
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Instances>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
        </Instances>
      </MemberInformation>
    </Update>
  </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>
    <UpdateResponse xmlns="http://imodules.com/WebServices/ControlQuery/">
      <UpdateResult>
        <UpdateMemberResult Imod_Member_Id="int" Constituent_Id="string" Is_New="boolean">
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <Error Code="int" Description="string" />
          <Message Code="int" Description="string" />
        </UpdateMemberResult>
        <UpdateMemberResult Imod_Member_Id="int" Constituent_Id="string" Is_New="boolean">
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <Error Code="int" Description="string" />
          <Message Code="int" Description="string" />
        </UpdateMemberResult>
        <Error Code="int" Description="string" />
      </UpdateResult>
    </UpdateResponse>
  </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/ControlQuery.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>
    <Update xmlns="http://imodules.com/WebServices/ControlQuery/">
      <login>string</login>
      <password>string</password>
      <controlId>int</controlId>
      <allowAddingConstituents>boolean</allowAddingConstituents>
      <MemberInformation Imod_Member_Id="int" Constituent_Id="string" Last_Updated="dateTime" Last_Updated_By_Constituent_Id="string" Last_Updated_By_Name="string">
        <Guests>
          <Guest IMod_Member_Id="int" />
          <Guest IMod_Member_Id="int" />
        </Guests>
        <GuestOf IMod_Member_Id="int" />
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Instances>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
        </Instances>
      </MemberInformation>
      <MemberInformation Imod_Member_Id="int" Constituent_Id="string" Last_Updated="dateTime" Last_Updated_By_Constituent_Id="string" Last_Updated_By_Name="string">
        <Guests>
          <Guest IMod_Member_Id="int" />
          <Guest IMod_Member_Id="int" />
        </Guests>
        <GuestOf IMod_Member_Id="int" />
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Column Name="string" Value="string">
          <Designations>
            <Designation xsi:nil="true" />
            <Designation xsi:nil="true" />
          </Designations>
        </Column>
        <Instances>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
          <Instance Instance_Id="string">
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
            <Transactions xsi:nil="true" />
          </Instance>
        </Instances>
      </MemberInformation>
    </Update>
  </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>
    <UpdateResponse xmlns="http://imodules.com/WebServices/ControlQuery/">
      <UpdateResult>
        <UpdateMemberResult Imod_Member_Id="int" Constituent_Id="string" Is_New="boolean">
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <Error Code="int" Description="string" />
          <Message Code="int" Description="string" />
        </UpdateMemberResult>
        <UpdateMemberResult Imod_Member_Id="int" Constituent_Id="string" Is_New="boolean">
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateColumnResult Name="string" Success="boolean">
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateColumnResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <UpdateInstanceResult Instance_Id="string" External_Id_Name="string" External_Id_Value="string">
            <UpdateColumnResult xsi:nil="true" />
            <UpdateColumnResult xsi:nil="true" />
            <Error xsi:nil="true" />
            <Message xsi:nil="true" />
          </UpdateInstanceResult>
          <Error Code="int" Description="string" />
          <Message Code="int" Description="string" />
        </UpdateMemberResult>
        <Error Code="int" Description="string" />
      </UpdateResult>
    </UpdateResponse>
  </soap12:Body>
</soap12:Envelope>