API Reference

Users.getConnections

Syntax

array users.getConnections ( int vhost, mixed emailList = array(), array phoneList = array(), int userId = 0, mixed mediaId = 0 )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The id of the vhost.
emailList	mixed	Optional	array()
phoneList	array	Optional	array()	An array of phone numbers to lookup
userId	int	Optional	0	User ID, if provided user list will state if users are already connected via isFollowed
mediaId	mixed	Optional	0

Array key / value pairs

The possible key value pairs that you can use in your userData array.

Name	Type	Required	Default Value	Description
user	STRING	Optional	none	Username for the account. The user parameter must only contain letters (a-z or A-Z), digits (0-9), underscore (_), hyphen (-), period (.), and the "at" sign (@).
email	STRING	Optional	none	Email address for the account holder. This has to be a properly formatted email address.
phone	STRING	Optional	none	The account holders phone number.
countrycode	INTEGER	Optional	none	The account holders phone country code.
firstname	STRING	Optional	none	Firstname for the account holder
lastname	STRING	Optional	none	Lastname for the account holder
password	STRING	Optional	random string	Password for the account holder (if none is provided the system will generate one and send it to the user)
address1	STRING	Optional	none	The account holders address.
address2	STRING	Optional	none	A second line for the account holders address.
city	STRING	Optional	none	The account holders city.
language	STRING	Optional	none	The language the account holder is using poss.
state	STRING	Optional	none	The account holders state/province.
country	STRING	Optional	none	The account holders country.
postalcode	STRING	Optional	none	The account holders zip or postal code.
birthdate	STRING	Optional	none	The account holders birth date.
cellphone	STRING	Optional	none	The account holders cell phone.
phone	STRING	Optional	none	The account holders phone number.
website	STRING	Optional	none	The account holders website.
accounttype	STRING	Optional	0	The account type for the account holder.
occupation	STRING	Optional	none	The account holders occupation.
newsletter	BOOLEAN	Optional	0	Whether the account holder wants to receive a newsletter.
profile_complete	BOOLEAN	Optional	0	If a users profile should be marked as complete or not.
gender	CHAR	Not required	none	The account holders gender, acceptable values are M or F.
meta	STRING	Optional	none	Any meta data you wish to store about the account holder.
external_id	STRING	Optional	none	The id provided by a 3rd party external authorization system. NB: This is to be used with 'external_id_provider'.
external_id_provider	INTEGER	Optional	none	The integer that represents the 3rd party that provided the external id. Possible values are: 1 (Facebook) 4 (Janrain) 5 (Gigya) 6 (Stripe) 7 (Google) 8 (Apple) 9 (Twitter) 10 (Instagram) 11 (YouTube) NOTE: The external_id_provider is required if external_id is passed.

Response

Below are the fields available in the returned array.

Name	Type	Description
id	INT	The user id for the requested users.
user	STRING	The user name for the requested users.
firstname	STRING	The first name for the requested users.
lastname	STRING	The last name for the requested users.
avatar	INT	The media items that the users may be using as their avatar.
city	STRING	The city in which the requested users live.
country	STRING	The country in which the requested users live.
gender	CHAR	The gender of the requested users. M for male and F for female.
birthdate	DATE	The date of birth for the requested users.
language	STRING	The user's preferred language. A two character ISO country code will be used.
email	STRING	The e-mail address of the requested users.
phone	STRING	The users phone number.
cellphone	STRING	The user's cell phone number.
state	STRING	The state in which the requested users live.
lastlogin	DATETIME	The date and time that the user was last logged into the system.
geo_latitude	FLOAT	The geographical latitude of the requested users.
geo_longitude	FLOAT	The geographical longitude of the requested users.
publicfiles	INT	The total number of media items the user has uploaded to the system. NOTE: You can find the value of notdeniedfiles by subtracting deniedfiles from publicfiles.
unmoderatedfiles	INT	The number of media items that the user has uploaded to the system that are yet to be moderated.
approvedfiles	INT	The number of media items the user has uploaded to the system that have been approved.
deniedfiles	INT	The number of media items the user has uploaded to the system that have been denied.
unmoderatedcomments	INT	The number of comments the user has posted that have yet to be moderated.
approvedcomments	INT	The number of comments the user has posted that have been approved. NOTE: You can find the value of notdeniedcomments by calculating the sum of approvedcomments plus unmoderatedcomments.
deniedcomments	INT	The number of comments the user has posted that have been denied.
notdeniedcomments	INT	The number of comments the user has posted that have been approved or have yet to be mopderated.
newsletter	BOOLEAN	Whether or not the user has requested the newsletter, 0 is false, 1 is true.
deviceinfo	ARRAY	An array of the user's devices. The values returned are as follows: (with i being the iterator of the user's devices, should the user have more than one) deviceinfo[i]['id'] - (Integer) The id of the device. ie. 54321 deviceinfo[i]['uid'] - (Integer) The id of the user. deviceinfo[i]['vhost'] - (Integer) The id of the vhost. deviceinfo[i]['device_id'] - (String) The string id of the device. ie: 1f6d530974e0aae8d6ad52734bcead167edab73d40127f8ec762f42d674386fb deviceinfo[i]['latitude'] - (FLoat) The latitude of the device. Ie: 43.635609 deviceinfo[i]['longitude'] - (FLoat) The longitude of the device. Ie: -79.424858 deviceinfo[i]['lastupdatetime'] - (Datetime) The datestamp of the last occurance that the device was used to connect to the application. Ie: 2012-12-07 11:40:56 deviceinfo[i]['commentnotification'] - (Integer) Indicates whether the user enabled their comment notifications or not. Values: 1 (yes) or 0 (no) deviceinfo[i]['assignmentnotification'] - (Integer) Indicates whether the user enabled their assignment notifications or not. Values: 1 (yes) or 0 (no) deviceinfo[i]['settings'] - a serialized string with the user's settings: ie: a:1:{s:22:"notificationBadgeCount";s:1:"0";} deviceinfo[i]['distance'] - (integer) The distance in meters from the deviceGeoCenter. This is returned only if filters[deviceGeoDistance] and filters[deviceGeoCenter] are provided.
externalids	ARRAY	The user's external IDs, if any.
created	DATETIME	The date and time that the user was created.
profile_complete	INT	Is the user's profile complete. 1 - yes, 0 - no.
disable_media_notifications	INT	Has the user disbled their media notifications: 1 - yes, 0 - no.
disable_thread_notifications	INT	Has the user disbled their thread notifications: 1 - yes, 0 - no.
occupation	STRING	The user's occupation.
friends	INT	The number of user's accepted friends.
followers	INT	The number of user's following the user.
following	INT	The number of user's the user follows.
vhost	INT	The application that the user is in.
meta	ARRAY	The user's meta data.
active	INT	Indicates whether or not a user account is active: 1 = active, 0 = inactive.
disabled	INT	Indicates whether or not a user account is disabled: 1 = disabled, 0 = enabled.
gravatarid	STRING	An md5 hash of the user's email address, which is used to confirm the user's gravatar.

Sample Response

Code examples

PHP-RPC

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

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'users.getConnections',
  'vhost' => '2',
  'emailList' => $emailList,
  'phoneList' => $phoneList,
  'userId' => $userId,
  'mediaId' => $mediaId
);

// 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($emailList),
  XML_RPC_encode($phoneList),
  XML_RPC_encode($userId),
  XML_RPC_encode($mediaId)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('users.getConnections',$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',
  $emailList,
  $phoneList,
  $userId,
  $mediaId
);

$data = $xmlrpc->invoke('users.getConnections',$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',
  $emailList,
  $phoneList,
  $userId,
  $mediaId
);

$data = $client->call('users.getConnections',$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 = "getConnections";
    myRemConn_rc.params = {2:vhost, emailList:emailList, phoneList:phoneList, userId:userId, mediaId:mediaId};
    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, emailList, phoneList, userId, mediaId);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("users.getConnections", 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/getConnections"

dim apiKey as string = "YOURAPIKEY"

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

' 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 getConnections ( emailList, phoneList, userId, mediaId ) {

var params = {
    "method" :      'users.getConnections',
    "vhost" :       2,
    "emailList" :   emailList,
    "phoneList" :   phoneList,
    "userId" :      userId,
    "mediaId" :     mediaId}

$.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->getConnections( 2, $emailList, $phoneList, $userId, $mediaId );

print_r($data);

0 comments

Be the first to comment on getConnections.

Developer Documentation Portal

API Reference

Users.getConnections

Syntax

Arguments

Array key / value pairs

Response

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