API Reference

Users.setPassword

Syntax

bool users.setPassword ( int vhost, string password, int uid = 0, string email = false, string username = false, string phone = false, string previousPassword = '', string verificationCode = NULL )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost id of the user
password	string	Required	none	The users new desired password
uid	int	Optional	0	The id of the user
email	string	Optional	false	The email of the user
username	string	Optional	false	The username of the user
phone	string	Optional	false	the user phone number
previousPassword	string	Optional	''	The users previous password, required if verification code is not provided.
verificationCode	string	Optional	NULL	The one time SMS or Email code the user received from regenerateCode - mandatory if previousPassword is non existant

Sample Response

Code examples

PHP-RPC

$path = 'https://api.newspark.ca/services/php';

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'users.setPassword',
  'vhost' => '2',
  'password' => $password,
  'uid' => $uid,
  'email' => $email,
  'username' => $username,
  'phone' => $phone,
  'previousPassword' => $previousPassword,
  'verificationCode' => $verificationCode
);

// http_build_query basically turns an array into a url-encoded list of variables
$url = $path .'?' . http_build_query($arguments,null,'&');

// get the contents from the specified url
$data = file_get_contents($url);

// transform it back into php data structures
$data = unserialize($data);

// the actual data is stored in $data['result']

print_r($data['result']);

PEAR XMLRPC client

// Include the client
require_once 'XML/RPC.php';

// Create the XMLRPC Client
$client = new XML_RPC_Client('/services/xmlrpc?APIKEY={YOURAPIKEY}', 'api.newspark.ca');

// PEAR's XML-RPC client requires all arguments to wrapped in a special value class
// XML_RPC_encode converts this automatically

$arguments = array(
  XML_RPC_encode('2'),
  XML_RPC_encode($password),
  XML_RPC_encode($uid),
  XML_RPC_encode($email),
  XML_RPC_encode($username),
  XML_RPC_encode($phone),
  XML_RPC_encode($previousPassword),
  XML_RPC_encode($verificationCode)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('users.setPassword',$arguments);

// Sending the message to the server
$response = $client->send($message);

// We also need to decode the response back to normal PHP types
$response = XML_RPC_decode($response);

print_r($response);

SabreTooth XMLRPC client

// Include the client
require_once 'Sabre/XMLRPC/Client.php';

// Create the XMLRPC Client
$xmlrpc = new Sabre_XMLRPC_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  '2',
  $password,
  $uid,
  $email,
  $username,
  $phone,
  $previousPassword,
  $verificationCode
);

$data = $xmlrpc->invoke('users.setPassword',$arguments);

print_r($data);

Zend XMLRPC client

// Include the client
require_once 'Zend/XmlRpc/Client.php';

// Create the XMLRPC Client
$client = new Zend_XmlRpc_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  '2',
  $password,
  $uid,
  $email,
  $username,
  $phone,
  $previousPassword,
  $verificationCode
);

$data = $client->call('users.setPassword',$arguments);

print_r($data);

Actionscript 2

    /*
     *     In ActionScript 2 remote service calls are done using the RemotingConnector Component.
     *     An instance of the component must exist on the stage and have an instance name.
     *
     *     Results and Faults are handled by addEventListener's and the call parameters are placed inside of an associative array
     *
     *     You must also specify the service class and method names under the appropriate property fields of the component
     */

    var gatewayURL:String = "/services/amf2";
    //Set up service call
    myRemConn_rc.gatewayUrl = gatewayURL;
    myRemConn_rc.serviceName = "users";
    myRemConn_rc.methodName = "setPassword";
    myRemConn_rc.params = {2:vhost, password:password, uid:uid, email:email, username:username, phone:phone, previousPassword:previousPassword, verificationCode:verificationCode};
    myRemConn_rc.addEventListener("result", widgetResult);
    myRemConn_rc.addEventListener("status", widgetFault);

    //Make the call
    myRemConn_rc.trigger();

    /*
    *  Handles service result.
    */
    function widgetResult(ev:Object){
        //Do stuff
        //Data is returned inside of ev.target.results
        //(i.e. ev.traget.results.description or ev.traget.results.settings.color)
    }

    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object){
        //Display Error
        trace("Categories Error - " + ev.code + " -  " + ev.data.faultstring);
    }

Actionscript 3

    /*
     *  In ActionScript 3 remote service calls are done using the NetConnection Object.
     *  A Responder Object controls what functions handle successful or failed calls
     *  and any parameters for the call are placed in an array and passed as a parameter
     *  in the NetConnection.call() method.
     */

    var gatewayURL:String = "/services/amf2";
    var parameters:Array = new Array(vhost, password, uid, email, username, phone, previousPassword, verificationCode);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("users.setPassword", new Responder(widgetResult, widgetFault), parameters);


    /*
     *   Handles service result.
     */
    function widgetResult(ev:Object):void{
        //Do stuff
        //Data is returned inside of ev
        //(i.e. ev.description or ev.settings.color)
    }


    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object):void{
        //Display Error
        error.showError(parentClip, ev.code + " -  " + ev.description, "Please refresh your browser to try again.");
        error.x = (parentClip.width - error.width) / 2;
        error.y = (parentClip.height - error.height) / 2;
    }

REST service example

<%@ Page Language="vb" %>
<%


' REST gateway
dim gateway as string = "http://api.newspark.ca/services/rest/"

' Service + method we're calling.
dim method as string = "users/setPassword"

dim apiKey as string = "YOURAPIKEY"

dim url as string = gateway & method & "?APIKEY=" & apiKey &  "&vhost=2" &  "&password=" & password

' HTTP Client
dim wcHTTPScrape as new System.net.WebClient()

' Opening a stream
dim objInput as System.IO.Stream = wcHTTPScrape.OpenRead(url)

dim objReader as new System.IO.StreamReader ( objInput )

' Reading the entire HTTP response and output it
Response.Write ( objReader.ReadToEnd () )


objReader.Close ()
objInput.Close ()

%>

jQuery JSON

/*
* jQuery post example
*/

function setPassword ( password, uid, email, username, phone, previousPassword, verificationCode ) {

var params = {
    "method" :      'users.setPassword',
    "vhost" :       2,
    "password" :    password,
    "uid" :         uid,
    "email" :       email,
    "username" :    username,
    "phone" :       phone,
    "previousPassword" : previousPassword,
    "verificationCode" : verificationCode}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Local API

// Get the Service Mapper

$mapper = Sabre_ServiceMap_Mapper::getMapper();

// Calling the method
$data = $mapper->users->setPassword( 2, $password, $uid, $email, $username, $phone, $previousPassword, $verificationCode );

print_r($data);

0 comments

Be the first to comment on setPassword.

Developer Documentation Portal

API Reference

Users.setPassword

Syntax

Arguments

Sample Response

Code examples

PHP-RPC

PEAR XMLRPC client

SabreTooth XMLRPC client

Zend XMLRPC client

Actionscript 2

Actionscript 3

REST service example

jQuery JSON

Local API

0 comments

Add a Comment