users.editProfileBlock

Description

Saves user responses for a specified profile block and field.

Authentication

This method requires authentication with ‘read’ permission.

API Version

Version 2

Required parameters

  • block_id
    the specified profile block
  • field_id
    the specified profile block field
  • target_user_id
    the specified user
  • userdata
    a string of data to save as the profile block field response

Optional parameters

  • None

Example response

A successful update will return the unique identifier for the new user data record.

<?xml version="1.0"?>
<response status="ok" time="Wed, 25 Mar 2009 04:34:09 +0000">
	<profile_block_items count="1">
		<profile_block_item>
			<userdata_id>63</userdata_id>
		</profile_block_item>
	</profile_block_items>
</response>

users.getProfileBlock

Description

Returns a list of profile blocks and their fields, or if called appropriately, returns a user’s responses for a given profile block.

Authentication

This method requires authentication with ‘read’ permission.

API Version

Version 2

Required parameters

  • None

Optional parameters

  • block_id
    the unique identifier of the block
  • user_id
    passing a user_id and a block_id together will provide you with the given user’s responses to the specified profile block
  • title
    the title of the block
  • tiers
    the tiers to which the profile block is applicable
  • modified
    the timestamp of the last modification
  • enabled
    whether or not the profile block is enabled

Example response

Profile block information:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok" time="Mon, 09 Mar 2009 07:04:59 +0000">
<profile_blocks count="2" total="2">
	<profile_block>
		<block_id>1</block_id>
		<title><![CDATA[Basic Information]]></title>
		<enabled>1</enabled>
		<tiers><![CDATA[1,2]]></tiers>
		<modified><![CDATA[Mon, 26 Jan 2009 23:55:33 +0000]]></modified>
		<fields>
			<field>
				<type>textField</type>
				<label>Location</label>
				<default_value>enter your location</default_value>
				<options_list/>
				<max_length>150</max_length>
				<required>1</required>
				<display_on_profile>1</display_on_profile>
				<display_on_registration>1</display_on_registration>
				<tiers>1,2</tiers>
				<sequence>1</sequence>
				<modified>2009-01-26 17:55:33</modified>
				<field_id>1</field_id>
			</field>
			<field>
				<type>textField</type>
				<label>Contact</label>
				<default_value>Enter your email address</default_value>
				<options_list/>
				<max_length>100</max_length>
				<required>1</required>
				<display_on_profile>1</display_on_profile>
				<display_on_registration>0</display_on_registration>
				<tiers>1,2</tiers>
				<sequence>2</sequence>
				<modified>2009-01-26 17:56:15</modified>
				<field_id>2</field_id>
			</field>
		</fields>
	</profile_block>
</profile_blocks>
</response>

Profile block information with user response values:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok" time="Mon, 09 Mar 2009 07:04:59 +0000">
<profile_blocks count="2" total="2">
	<profile_block>
		<block_id>1</block_id>
		<title><![CDATA[Basic Information]]></title>
		<enabled>1</enabled>
		<tiers><![CDATA[1,2]]></tiers>
		<modified><![CDATA[Mon, 26 Jan 2009 23:55:33 +0000]]></modified>
		<fields>
			<field>
				<type>textField</type>
				<label>Location</label>
				<default_value>enter your location</default_value>
				<options_list/>
				<max_length>150</max_length>
				<required>1</required>
				<display_on_profile>1</display_on_profile>
				<display_on_registration>1</display_on_registration>
				<tiers>1,2</tiers>
				<sequence>1</sequence>
				<modified>2009-01-26 17:55:33</modified>
				<field_id>1</field_id>
				<userdata><![CDATA[Austin, TX]]></userdata>
			</field>
			<field>
				<type>textField</type>
				<label>Contact</label>
				<default_value>Enter your email address</default_value>
				<options_list/>
				<max_length>100</max_length>
				<required>1</required>
				<display_on_profile>1</display_on_profile>
				<display_on_registration>0</display_on_registration>
				<tiers>1,2</tiers>
				<sequence>2</sequence>
				<modified>2009-01-26 17:56:15</modified>
				<field_id>2</field_id>
				<userdata><![CDATA[nobody@nowhere.com]]></userdata>
			</field>
		</fields>
	</profile_block>
</profile_blocks>
</response>

users.editProfileComments

Description

Edits the specified profile comment, if no profile comment was specified, a new profile comment will be made.

Authentication

This method requires authentication without user credentials.

API Version

Version 1&2

Required parameters

  • user_id :
    the id of the blog containing the post. The list of blogs is available from the users.getProfileComments call.
  • target_user_id :
    the profile id the comment is being made to.
  • subject :
    the profile comment subject.
  • body :
    the profile comment.

Optional parameters

  • post_id :
    the id number of a particular profile comment

Example response

<?xml version="1.0"?>
<response status="ok" time="Fri, 18 Apr 2008 12:57:21 -0500">
    <users count="1">
        <user>
            <post_id>1</post_id>
        </user>
    </users>
</response>

users.editUser

Description

Edits the default information for a user

Authentication

This method requires authentication with ‘write’ permission.

API Version

Version 1&2

Required parameters

  • target_user_id:The user ID of the user to edit

Optional parameters

  • password:
    The user’s password
  • email_address:
    The user’s email address if it changed
  • username:
    The user’s username if usernames are in use, OR
  • first_name:
    The user’s first name if usernames are NOT in use
  • last_name:
    The user’s last name if usernames are NOT in use
  • date_joined:
    The date the user joined the site, formatted according to RFC 822 standard or as a Unix time stamp
  • activated:
    a value of 1 to make the user’s account active, 0 to de-activate
  • status:
    value of 1 to make the user’s account a normal account, -1 suspended, -2 deleted
  • tier:
    The numeric ID of the tier to which the user belongs

Example response

<?xml version="1.0"?>
<response status="ok" time="Mon, 21 Apr 2008 13:50:31 -0500">
    <users count="1">
        <user>
            <user_id>1</user_id>
        </user>
    </events>
</response>

users.getFiles

Description

Returns the list of files stored in the user’s ‘Files’ module.

API Version

Version 1&2

Required parameters

  • user_id – The ID of the specified user

Example response

users.getList

Description

Returns a list of site users.

API Version

Version 1&2

Required parameters

  • None

Optional parameters

  • user_id – can also be a comma separated list of multiple user ids
  • username
  • email_address
  • last_login
  • date_joined
  • tier
  • featured
  • most_recent
  • ss_key
  • interest_key
  • subinterest_key
  • has_photos – if set to true, returns only users with photos
  • show_all – if set to true, returns inactive users as well

Example response

<?xml version="1.0"?>
<response status="ok" time="Tue, 22 Apr 2008 16:43:59 -0500">
    <users count="2" total="31">
        <user>
            <user_id>29</user_id>
            <username>
                <![CDATA[Bob Smith]]>
            </username>
            <email_address>
                <![CDATA[bob@example.com]]>
            </email_address>
            <last_login>1207683694</last_login>
            <date_joined>
                <![CDATA[2008-04-08 19:41:14]]>
            </date_joined>
            <status>1</status>
            <thumb_link/>
            <tier>0</tier>
        </user>
        <user>
            <user_id>28</user_id>
            <username>
                <![CDATA[Alice Jones]]>
            </username>
            <email_address>
                <![CDATA[ajones@example.com]]>
            </email_address>
            <last_login>1206399214</last_login>
            <date_joined>
                <![CDATA[2008-03-24 22:52:04]]>
            </date_joined>
            <status>-1</status>
            <thumb_link/>
            <tier>0</tier>
        </user>
    </users>
</response>

users.getNetwork

Description

Returns a list of connections, or “friends”, for the specified user.

API Version

Version 1&2

Required parameters

  • user_id – The ID of the user

Example response

users.getProfileComments

Description

Returns a list of comments on the user’s profile page.

API Version

Version 1&2

Required parameters

  • user_id – The ID of the specified user

Example response