Difference between revisions of "ModifyUser"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A...")
 
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=Modify User and login data for a user.
 +
 
 +
 
 +
The following data that can be edited:
 +
*First Name
 +
*Last Name
 +
*Password
 +
*Email
 +
*Birth Date
 +
*Gender
  
 
|Parameters=
 
|Parameters=
Line 12: Line 21:
 
{{Api_Parameter|
 
{{Api_Parameter|
 
ParamName=userData
 
ParamName=userData
|ParamType=
+
|ParamType=JSON Array of [[RegistrationFieldCallback]]
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=JSON-encoded array of RegistrationFieldCallback objects.
 
}}
 
}}
  
Line 27: Line 36:
 
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
 
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
:    <span style="color: #a11;">"Content"</span>:  
+
:    <span style="color: #a11;">"Content"</span>: <span style="color: #219;">true</span>
::    { <span style="color: #219;">Array of [[LiveChannel]] objects</span> }
 
 
}
 
}
  

Latest revision as of 15:22, 16 February 2016

Description

Modify User and login data for a user.


The following data that can be edited:

  • First Name
  • Last Name
  • Password
  • Email
  • Birth Date
  • Gender

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
JSON-encoded array of RegistrationFieldCallback objects.


Returns

Returns a JSON object containing an ...

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": true

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also