Testopia:Documentation:XMLRPC:User: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(Replacing page with ' see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/User.html')
 
Line 1: Line 1:
__NOEDITSECTION__
see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/User.html
Back to [[Testopia:Documentation:XMLRPC]]
 
==User==
 
===Description===
An object representing a Bugzilla WebService user.
 
===Hiearchy===
Bugzilla::WebService::User
 
===Attributes===
 
{| border=1 cellpadding=4
| '''Attribute''' || '''Data Type''' || '''Comments'''
|-
| id || integer ||
|-
| login || integer ||
|-
| email || string ||
|-
| name || string ||
|-
| disabledtext || string ||
|-
| is_disabled || integer ||
|-
| showmybugslink || integer ||
|-
|}
 
 
===Methods===
 
----
====lookup_id_by_login - Lookup A User ID By Its Login====
----
 
=====Usage=====
User.lookup_id_by_login
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| login || string || Cannot be null or empty string
|-
|}
 
 
=====Result=====
The user id for the respective login or 0 if an error occurs.
 
=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(loginEmail);
Integer result = (Integer) client.execute("User.lookup_id_by_login",params);
 
<b>Perl</b>
my $user_login = 'user@company.com'
my $result = $proxy->call('User.lookup_id_by_login', $user_login);
 
 
----
====lookup_login_by_id - Lookup A Login By Its ID====
----
 
=====Usage=====
User.lookup_login_by_id
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| id || integer || Cannot be 0
|-
|}
 
 
=====Result=====
The user login for the respective id or empty string if an error occurs.
 
=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(loginID);
Integer result = (Integer) client.execute("User.lookup_login_by_id",params);
 
<b>Perl</b>
my $user_id = 1;
$proxy->call('User.lookup_login_by_id', $user_id);
 
 
 
<br>Back to [[Testopia]]

Latest revision as of 17:08, 23 June 2008