Difference between revisions of "UpdateUserFirstAccess"

From Gvp-public
Jump to navigation Jump to search
 
(One intermediate revision by one other user not shown)
Line 10: Line 10:
 
|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=pinType
 +
|ParamType=Enum
 +
|ParamRequired=required
 +
|ParamDescription=Pin Type Enum.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=value
 +
|ParamType=Boolean
 +
|ParamRequired=required
 +
|ParamDescription=Value for First Pin Use.
 +
}}
 +
  
  

Latest revision as of 09:17, 28 November 2022

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.
  • pinType (Enum, required)
Pin Type Enum.
  • value (Boolean, required)
Value for First Pin Use.


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