Site:API:Users
From Metrixstream
(Difference between revisions)
MetrixAdmin (Talk | contribs) m (→Optional Parameters) |
MetrixAdmin (Talk | contribs) (→Optional Parameters) |
||
| (3 intermediate revisions by one user not shown) | |||
| Line 17: | Line 17: | ||
=== Optional Parameters === | === Optional Parameters === | ||
| − | + | * <code>email</code> | |
| − | + | * <code>commission_pto_percentage</code> | |
| − | + | * <code>commission_ppm_percentage</code> | |
| − | + | * <code>commission_gift_percentage</code> | |
| − | + | * <code>commission_bandwidth_percentage</code> | |
| − | + | * <code>activity_summary_duration_secs</code> | |
=== Successful Response === | === Successful Response === | ||
| Line 33: | Line 33: | ||
== Edit User == | == Edit User == | ||
| − | This API call is responsible for | + | This API call is responsible for editing a user object. |
=== Authentication Restrictions === | === Authentication Restrictions === | ||
| Line 41: | Line 41: | ||
=== Required Parameters === | === Required Parameters === | ||
| − | * <code>action= | + | * <code>action=user</code> |
| − | * <code> | + | * <code>verb=edituser</code> |
=== Optional Parameters === | === Optional Parameters === | ||
| Line 82: | Line 82: | ||
* <code>billing_city</code> | * <code>billing_city</code> | ||
* <code>billing_state</code> | * <code>billing_state</code> | ||
| + | * <code>billing_zip</code> | ||
* <code>billing_country</code> | * <code>billing_country</code> | ||
* <code>billing_email</code> | * <code>billing_email</code> | ||
Latest revision as of 10:32, 22 August 2012
Contents |
[edit] Users
[edit] Add User
This API call is responsible for creating a user.
[edit] Authentication Restrictions
Administrator only.
[edit] Required Parameters
-
action=user -
verb=adduser -
username: the username of the user
[edit] Optional Parameters
-
email -
commission_pto_percentage -
commission_ppm_percentage -
commission_gift_percentage -
commission_bandwidth_percentage -
activity_summary_duration_secs
[edit] Successful Response
-
status=ok -
item-
user-
id: the id of the user
-
-
[edit] Edit User
This API call is responsible for editing a user object.
[edit] Authentication Restrictions
Any authenticated user.
[edit] Required Parameters
-
action=user -
verb=edituser
[edit] Optional Parameters
-
user: the username of the user being updated.
- this parameter is only available if the authenticated user is an Administrator.
-
username -
password -
email -
newsletter -
external_id -
phone -
fax -
dob -
dob_day -
dob_month -
dob_year -
description -
display_name -
display_status -
lang -
sex -
relationship -
interests -
activities -
music -
tv -
books -
location -
hometown -
change_username -
allow_login -
price_level -
billing_fname -
billing_lname -
billing_company -
billing_address -
billing_address2 -
billing_city -
billing_state -
billing_zip -
billing_country -
billing_email -
billing_phone -
billing_fax -
shipping_fname -
shipping_lname -
shipping_company -
shipping_address -
shipping_address2 -
shipping_city -
shipping_state -
shipping_zip -
shipping_country -
shipping_email -
shipping_phone -
shipping_fax -
bank_name -
bank_address -
bank_address2 -
bank_city -
bank_state -
bank_zip -
bank_country -
bank_account -
bank_routing -
bank_swift -
bank_phone -
bank_iban -
review -
status -
commission_ppm_percentage -
commission_pto_percentage -
commission_gift_percentage -
commission_bandwidth_percentage -
activity_summary_duration_secs -
banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart) -
cst_*: custom fields related to this user
- replace the * with the appropriate custom field name
[edit] Successful Response
-
status=ok -
properties-
pending -
approved
-
