Difference between revisions of "UpdateUserFirstAccess"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Set the variable PinFirstUse to false. This flag is used when the user were in his first access of platform, usually when he |Parameters= {{A...") |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Set the variable PinFirstUse to false. This flag is used when the user were in his first access of platform, usually when he | + | 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= | |Parameters= | ||
| Line 11: | Line 11: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=pinType |
| − | |ParamType= | + | |ParamType=Enum |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=Pin Type Enum. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=value |
| − | |ParamType= | + | |ParamType=Boolean |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Value for First Pin Use. |
}} | }} | ||
| + | |||
| + | |||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing true for successful. |
'''Example:''' | '''Example:''' | ||
| Line 38: | Line 34: | ||
: <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> |
| − | |||
} | } | ||
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 |
