NewsCloud Web Services
API Categories
User Functions- userChangePassword
- userCheckMemberName
- userCreateAccount
- userForgotPassword
- userGetInfo
- userGetJournalUrl
- userGetPhotoUrl
- userGetTagCloud
- userListComments
- userListGroups
- userListTags
- userListVotes
- userPostComment
- userSetInfo
- userSignIn
userChangePassword
Change the user's password. Under special restriction.
Arguments
uid: the user id for this user
oldPwd: The user's existing password.
newPwd: The user's new password.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userCheckMemberName
Checks to see if this member name is unique before registering. Under special restriction.
Arguments
memberName: the member name of the user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userCreateAccount
Registers a new user at NewsCloud. Under special restriction.
Arguments
email: the email address for this user
memberName: the member name of the user
password: the password for this user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userForgotPassword
Resends a login link to the user in case they forgot their password. Under special restriction.
Arguments
email: the email address for this user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userGetInfo
Get the settings and properties for the user. Requires account access.
Arguments
uid: the user id for this user
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userGetInfo&uid=38
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
userGetJournalUrl
Private function in apiNewsCloud.class.php. Returns url to the journal with this user
Arguments
uid: the user id for this user
Usage:$temp=$this->apiNewsCloud->userGetJournalUrl($uid);
Link to <a href="'.$temp.'">User journal</a>
userGetPhotoUrl
Private function in apiNewsCloud.class.php. Returns url of profile icon for this user.
Arguments
uid: the user id for this user
Usage:$temp=$this->apiNewsCloud->userGetPhotoUrl($uid);
<img src="'.$temp.'">
userGetTagCloud
Get a list of the user's most frequently used tags. Under special restriction.
Arguments
uid: the user id for this user
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userGetTagCloud&uid=1
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userListComments
List all the comments this user has posted.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListComments&uid=38&startRow=10
userListGroups
List the groups this user is a member of.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListGroups&uid=38&startRow=0
userListTags
Get a list of the user's tags
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListTags&uid=38&startRow=10
userListVotes
List all the votes this user has made.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListVotes&uid=38&startRow=10
userPostComment
Post a comment for this user. Requires account access. Under special restriction.
Arguments
uid: the user id for this user
contentid: the contentid for this story
subject: The subject for the user comment.
comments: The body of the message for the user comment. Alternately, a description of a group.
commentType: Always 'story' for now. Only supported argument.
isTest: Used for testing APIs that write to the database. When isTest is true, nothing gets written to the database.
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userSetInfo
Change the profile settings of this user. Requires account access. Under special restriction.
Arguments
uid: the user id for this user
age: The age of the user.
gender: A gender to search for male, female or all. Or in set profile: male, female, other, unknown.
city: The city the user lives in.
state: The two digit abbreviation for the state, territory or province the user lives in.
postal: Postal code such as 98103
socialUrl: The URL to the user's social network page e.g. a myspace or friendster URL
personalUrl: The URL to the user's personal Web page or blog
chatName: The user's chat member name for instant messenger services.
chatService: The user's instant message service e.g. Skype, AOL, Yahoo, Google, MSN, ICQ, Other
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userSignIn
Create a new session for this user so that you can work with their account via the API. Once your log in is approved, you can access this user's account for one hour.
Arguments
email: the email address for this user
password: the password for this user
userChangePassword
Change the user's password. Under special restriction.
Arguments
uid: the user id for this user
oldPwd: The user's existing password.
newPwd: The user's new password.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userCheckMemberName
Checks to see if this member name is unique before registering. Under special restriction.
Arguments
memberName: the member name of the user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userCreateAccount
Registers a new user at NewsCloud. Under special restriction.
Arguments
email: the email address for this user
memberName: the member name of the user
password: the password for this user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userForgotPassword
Resends a login link to the user in case they forgot their password. Under special restriction.
Arguments
email: the email address for this user
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userGetInfo
Get the settings and properties for the user. Requires account access.
Arguments
uid: the user id for this user
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userGetInfo&uid=38
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
userGetJournalUrl
Private function in apiNewsCloud.class.php. Returns url to the journal with this user
Arguments
uid: the user id for this user
Usage:$temp=$this->apiNewsCloud->userGetJournalUrl($uid);
Link to <a href="'.$temp.'">User journal</a>
userGetPhotoUrl
Private function in apiNewsCloud.class.php. Returns url of profile icon for this user.
Arguments
uid: the user id for this user
Usage:$temp=$this->apiNewsCloud->userGetPhotoUrl($uid);
<img src="'.$temp.'">
userGetTagCloud
Get a list of the user's most frequently used tags. Under special restriction.
Arguments
uid: the user id for this user
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userGetTagCloud&uid=1
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userListComments
List all the comments this user has posted.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListComments&uid=38&startRow=10
userListGroups
List the groups this user is a member of.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListGroups&uid=38&startRow=0
userListTags
Get a list of the user's tags
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListTags&uid=38&startRow=10
userListVotes
List all the votes this user has made.
Arguments
uid: the user id for this user
startRow: the start row to begin the query
REST Format:http://api.newscloud.com/services/node.php?apikey=your-apikeyhere&method=userListVotes&uid=38&startRow=10
userPostComment
Post a comment for this user. Requires account access. Under special restriction.
Arguments
uid: the user id for this user
contentid: the contentid for this story
subject: The subject for the user comment.
comments: The body of the message for the user comment. Alternately, a description of a group.
commentType: Always 'story' for now. Only supported argument.
isTest: Used for testing APIs that write to the database. When isTest is true, nothing gets written to the database.
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userSetInfo
Change the profile settings of this user. Requires account access. Under special restriction.
Arguments
uid: the user id for this user
age: The age of the user.
gender: A gender to search for male, female or all. Or in set profile: male, female, other, unknown.
city: The city the user lives in.
state: The two digit abbreviation for the state, territory or province the user lives in.
postal: Postal code such as 98103
socialUrl: The URL to the user's social network page e.g. a myspace or friendster URL
personalUrl: The URL to the user's personal Web page or blog
chatName: The user's chat member name for instant messenger services.
chatService: The user's instant message service e.g. Skype, AOL, Yahoo, Google, MSN, ICQ, Other
Account Access: Because this method accesses a specific user account's private data, you either need to use the API key from the account of this user OR you must authenticate access to the user's account with userSignIn method before calling this function. Once signed in for this user's account, your session will last one hour.
Special Restriction: Because this is an intensive or important write operation, this method is under tight restrictions to prevent spam and abuse. Please email us if you have a valid use for your Web site and would like your limit increased. In most cases, we will be glad to accomodate you.
userSignIn
Create a new session for this user so that you can work with their account via the API. Once your log in is approved, you can access this user's account for one hour.
Arguments
email: the email address for this user
password: the password for this user
