Difference between revisions of "GetApplicationToken"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Given a valid challenge code returned by the RegisterTrustedDeviceChallenge method, returns an application token that can be used to identify th...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 23: | Line 23: | ||
ParamName= applicationDeviceId | ParamName= applicationDeviceId | ||
|ParamType=String | |ParamType=String | ||
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription=Unique identifier of the device that will be running the paired application. | |ParamDescription=Unique identifier of the device that will be running the paired application. | ||
}} | }} | ||
| Line 29: | Line 29: | ||
ParamName= applicationDeviceTypeId | ParamName= applicationDeviceTypeId | ||
|ParamType=int | |ParamType=int | ||
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription=Application device type id. For example for the rPVR application, it should 8601, as defined in the GVP_DEVICES_TYPES table. | |ParamDescription=Application device type id. For example for the rPVR application, it should 8601, as defined in the GVP_DEVICES_TYPES table. | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName= applicationDeviceName | ParamName= applicationDeviceName | ||
| − | |ParamType= | + | |ParamType=String |
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription=Friendly name of the device that will be running the paired application. | |ParamDescription=Friendly name of the device that will be running the paired application. | ||
}} | }} | ||
| Line 41: | Line 41: | ||
ParamName= applicationDeviceDescription | ParamName= applicationDeviceDescription | ||
|ParamType=String | |ParamType=String | ||
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription=An application defined description of the device that will be running this application. Used for BI purposes. | |ParamDescription=An application defined description of the device that will be running this application. Used for BI purposes. | ||
}} | }} | ||
Latest revision as of 14:51, 16 February 2016
Description
Given a valid challenge code returned by the RegisterTrustedDeviceChallenge method, returns an application token that can be used to identify the application as a specific user using the LoginApplicationToken method. If this method succeeds, it effectively completes the pairing an application to a trusted device.
An unique authentication code that will be used to identifiy the paired application for login purposes
A valid challenge code means a challenge code that is not expired.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- challengeCode (String, required)
- Challenge returned by the RegisterTrustedDeviceChallenge method
- applicationDeviceId (String, required)
- Unique identifier of the device that will be running the paired application.
- applicationDeviceTypeId (int, required)
- Application device type id. For example for the rPVR application, it should 8601, as defined in the GVP_DEVICES_TYPES table.
- applicationDeviceName (String, required)
- Friendly name of the device that will be running the paired application.
- applicationDeviceDescription (String, required)
- An application defined description of the device that will be running this application. Used for BI purposes.
Returns
Returns a JSON object containing a response from the method.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ""
}
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 |
