Difference between revisions of "UpdateUserFirstAccess"

From Gvp-public
Jump to navigation Jump to search
Line 9: Line 9:
 
|ParamRequired=required
 
|ParamRequired=required
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
 
{{Api_Parameter|
 
ParamName=offset
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The offset number of the returned values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The limit number of values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=subscriptionId
 
|ParamType=int
 
|ParamRequired=required
 
|ParamDescription=The subscriptionId that wants request the data.
 
 
}}
 
}}
 +
  
 
|Returns=
 
|Returns=
Returns a JSON object containing an array of [[LiveChannel]].
+
Returns a JSON object containing true for successful.
  
 
'''Example:'''
 
'''Example:'''
Line 38: Line 21:
 
:    <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> }
 
 
}
 
}
  

Revision as of 13:15, 11 August 2014

Description

Set the variable PinFirstUse to false. This flag is used when the user were in his first access of platform, usually when he is a recently registered user. So it can identify for the software a situation like "In the first access you need to set your parental pin and change your rental pin".

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.


Returns

Returns a JSON object containing true for successful.

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