• Sign up
  • Login
  • Email us
  • tweet this image
withVectorsTab-97x42
We's got 19,764,828 images, yo!
Advanced Search

API Access

API Documentation - getUserData

Gets data on the currently logged in user

Authentication

This method requires authentication. The account that you log in as will need an active subscription with downloads available. Use loginUser to log in a user.

Arguments

Argument Type Element (array) Valid Values Default Value Detail
api_key string none you need a valid api key to use the API
session_id string existing session id none use loginUserto get a session id

Returned Values

Element (path) Name Type Description
/ id int user id
/ id32 string unique 32 character string identifying the user
/ lastname string user's last name
/ firstname string user's first name
/ max_free_downloads int maximum quota for free downloads for the user
/ max_premium_downloads int maximum quota for premium downloads for the user
/ subscription_purchase_url string url to send a user to to purchase a subscription

Example Query


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
  <methodName>user.getUserData</methodName>
  <params>
    <param>
      <value>
        <string>YOUR_API_KEY</string>
      </value>
    </param>
    <param>
      <value>
        <string>SESSION_ID</string>
      </value>
    </param>
  </params>
</methodCall>

Example Response


<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>
              <int>MEMBER_ID</int>
            </value>
          </member>
          <member>
            <name>id32</name>
            <value>
              <string>2Q8qwbeY8pZCNxBgABg3yBv3q9nt3zQy</string>
            </value>
          </member>
          <member>
            <name>lastname</name>
            <value>
              <string>Smith</string>
            </value>
          </member>
          <member>
            <name>firstname</name>
            <value>
              <string>John</string>
            </value>
          </member>
          <member>
            <name>max_free_downloads</name>
            <value>
              <int>0</int>
            </value>
          </member>
          <member>
            <name>max_premium_downloads</name>
            <value>
              <int>25</int>
            </value>
          </member>
          <member>
            <name>subscription_purchase_url</name>
            <value>
              <string>SUBSCRIPTION_PURCHASE_URL</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

Copyright © PhotoXpress LLC 2009-2011 - All rights reserved