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