Getting User Account Details

Use the get operation to retrieve the information on user accounts.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving information about user accounts includes the get operation node:

<packet>
<user>
   <get>
   ...
   </get>
</user>
</packet>

 

The get node is nested within the UserGetInput type (user.xsd). This node has the following graphics representation:

user-get-rps.gif

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The get node of the response packet is structured as follows:

user-get-reps.gif

 

The data node is structured as follows:

 

Samples

A request packet to get a user account details can look as follows:

<packet>
<user>
<get>
   <filter>
      <guid>96197aa9-389a-db5b-aadc-88350b24fcdd</guid>
   </filter>
<dataset>
  <gen-info/>
</dataset>
</get>
</user>
</packet>

Response:

<packet version="1.6.3.0">
  <user>
    <get>
      <result>
        <status>ok</status>
        <filter-id>96197aa9-389a-db5b-aadc-88350b24fcdd</filter-id>
        <id>1</id>
        <data>
          <gen-info>
            <login>admin</login>
            <name>Eugene Grin</name>
            <owner-guid>58bb9092-4c8b-4110-ba3d-c40bdad3b178</owner-guid>
            <status>enabled</status>
            <guid>96197aa9-389a-db5b-aadc-88350b24fcdd</guid>
            <is-built-in>1</is-built-in>
            <contact-info>
              <company>Grin LLC</company>
              <phone>0-000-0000000</phone>
              <fax/>
              <address>New York</address>
              <city>New York</city>
              <state>New York</state>
              <zip>10101</zip>
              <country>US</country>
            </contact-info>
            <external-id/>
          </gen-info>
        </data>
      </result>
    </get>
  </user>
</packet>