Site:API:Users

From Metrixstream
(Difference between revisions)
Jump to: navigation, search
m (Edit Content)
m (Optional Parameters)
Line 117: Line 117:
 
* <code>commission_bandwidth_percentage</code>
 
* <code>commission_bandwidth_percentage</code>
 
* <code>activity_summary_duration_secs</code>
 
* <code>activity_summary_duration_secs</code>
 
+
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code>
* <code></code>
+
* <code>cst_*</code>: custom fields related to content
* <code></code>
+
:: replace the * with the appropriate custom field name
* <code></code>
+
* <code></code>
+
* <code>cst_*</code>
+
 
+
 
+
 
+
 
+
;title
+
;description
+
;access
+
;release_date
+
;event_date
+
;live_host
+
;live_mode
+
;preview_offset
+
;preview_duration
+
;external_id
+
;allow_oversell
+
;price
+
;price1
+
;price2
+
;price3
+
;price4
+
;price_formula
+
;credits_to_own
+
;credits_per_minute
+
;commission_ppm_percentage
+
;commission_pto_percentage
+
;commission_gift_percentage
+
;commission_bandwidth_percentage
+
;review
+
;gift_credits
+
;user
+
;chat_muted
+
;img:selected
+
;img:title
+
;img:position
+
;photo_hint
+
;add:relationship
+
;del:relationship
+
;playlist:media_id
+
;image (multipart)
+
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)
+
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10
+
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo
+
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot
+
;inventory
+
;inventory:stock:quantity
+
;featured_on_content_id
+
;tags
+
;addtag
+
;deletetag
+
;categories
+
;addcategory
+
;deletecategory
+
;label
+
;label_hint
+
;cst_*
+
;custom fields related to content; replace the * with the appropriate custom field name.
+
  
 
=== Successful Response ===
 
=== Successful Response ===

Revision as of 22:28, 20 August 2012

Contents

Users

Add User

This API call is responsible for creating a user.

Authentication Restrictions

Administrator only.

Required Parameters

  • action=user
  • verb=adduser
  • username: the username of the user

Optional Parameters

email
commission_pto_percentage
commission_ppm_percentage
commission_gift_percentage
commission_bandwidth_percentage
activity_summary_duration_secs

Successful Response

  • status=ok
  • item
    • user
      • id: the id of the user

Edit User

This API call is responsible for updating a user object.

Authentication Restrictions

Any authenticated user.

Required Parameters

  • action=updateuser
  • contentId: the id of the content item.

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_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 content
replace the * with the appropriate custom field name

Successful Response

status=ok
properties
pending
approved
Personal tools