XML-RPC Detailed Examples

SQLAPI.Login

Requesting a login for user "Sally Sales" with email "ssales@tigerpond.com" and password "sally" for an infinite session (empty "timestamp"):

<?xml version="1.0"?>
<methodCall>
  <methodName>sqlapi.login</methodName>
  <params>
    <!-- email -->
    <param><value><string>ssales@tigerpond.com</string></value></param>
    <!-- timestamp (empty) -->
    <param><value><string></string></value></param>
    <!-- password -->
    <param><value><string>sally</string></value></param>
  </params>
</methodCall>

Result:

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array><data>
            <!-- login status -->
            <value><string>ok</string></value>
            <!-- user_id -->
            <value><string>8881</string></value>
            <!-- timestamp (empty = infinite) -->
            <value><string/></value>
            <!-- token -->
            <value><string>7977D6B808C0328B779AEA74E03387D853CF003F</string></value>
        </data></array>
      </value>
    </param>
  </params>
</methodResponse>

SQLAPI.Object_Types

Requests a list of all available object types in the target system.

Request:

<?xml version="1.0"?>
<methodCall>
  <methodName>sqlapi.object_types</methodName>
  <params>
    <param>
      <value>
        <!-- AuthInfo array -->
        <array><data>
            <value><string>token</string></value>
            <value><i4>8881</i4></value>
            <value><string/></value>
            <value><string>7977D6B808C0328B779AEA74E03387D853CF003F</string></value>
        </data></array>
      </value>
    </param>
  </params>
</methodCall>

Reply:

<?xml version="1.0"?>
<methodResponse>
<params>
  <param>
    <value>
      <array><data>
          <value><string>ok</string></value>
          <value>
            <array><data>
                <value><array><data>
                  <value><string>acs_mail_body</string></value>
                  <value><string>ACS Mail Body</string></value>
                </data></array></value>
                ...
                <value><array><data><value>
                  <string>workflow</string></value>
                <value><string>Workflow</string></value>
            </data></array>
          </value>
      </data></array>
    </value>
  </param>
</params>
</methodResponse>

SQLAPI.Select

Requests a list of all available objects of type "im_project" which satisfy the condition of "project_name like 'Test%'".

Request:

<?xml version="1.0"?>
<methodCall>
  <methodName>sqlapi.select</methodName>
  <params>
    <!-- Auth_Info -->
    <param>[AuthInfo param, like before]</param>
    <!-- Object Type -->
    <param><value><string>im_project</string></value></param>
    <!-- List of query conditions of <variable> <operator> <argument> -->
    <param>
      <value><array><data>
        <value><array><data>
          <value><string>project_name</string></value>
          <value><string>like</string></value>
          <value><string>Test%</string></value>
        </data></array></value>
        <value><array><data>
          <value><string>project_id</string></value>
          <value><string>&lt;</string></value>
          <value><string>12345</string></value>
        </data></array></value>
      </data></array></value>
    </param>
  </params>
</methodCall>

Reply:

<?xml version="1.0"?>
<methodResponse>
<params>
  <param>
    <value>
      <array><data>
          <value><string>ok</string></value>
          <value>
            <array><data>
                <!-- now comes a list of [project_id + project_name] -->
                <value><array><data><value><i4>15982</i4></value><value><string>Test Project 1</string></value></data></array></value>
                <value><array><data><value><i4>9772</i4></value><value><string>Test Project 2</string></value></data></array></value>
                ...
            </data></array>
          </value>
      </data></array>
    </value>
  </param>
</params>
</methodResponse>


SQLAPI.Select

Requests a list of all available object types in the target system.

Request:

<?xml version="1.0"?>
<methodCall>
  <methodName>sqlapi.select</methodName>
  <AuthInfo param, like before>
</methodCall>

Reply:

<?xml version="1.0"?>
<methodResponse>
<params>
  <param>
    <value>
      <array><data>
          <value><string>ok</string></value>
          <value>
            <array><data>
                <!-- project_id + project_name -->
                <value><array><data><value><i4>15982</i4></value><value><string>Test Project 1</string></value></data></array></value>
                <value><array><data><value><i4>9772</i4></value><value><string>Test Project 2</string></value></data></array></value>
                ...
            </data></array>
          </value>
      </data></array>
    </value>
  </param>
</params>
</methodResponse>

Quick Feedback:

Please help us to improve the quality of our websites and report any type of spelling/grammar errors and other obliquities using this form.
To get in touch with us regarding other topics please use our contact form.

Name:  E-Mail:


Message: