editor
725
edits
Changes
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..."
{{Api_Method_Spec|
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName= challengeCode
|ParamType=String
|ParamRequired=required
|ParamDescription=Challenge returned by the RegisterTrustedDeviceChallenge method
}}
{{Api_Parameter|
ParamName= applicationDeviceId
|ParamType=String
|ParamRequired=
|ParamDescription=Unique identifier of the device that will be running the paired application.
}}
{{Api_Parameter|
ParamName= applicationDeviceTypeId
|ParamType=int
|ParamRequired=
|ParamDescription=Application device type id. For example for the rPVR application, it should 8601, as defined in the GVP_DEVICES_TYPES table.
}}
{{Api_Parameter|
ParamName= applicationDeviceName
|ParamType=int
|ParamRequired=
|ParamDescription=Friendly name of the device that will be running the paired application.
}}
{{Api_Parameter|
ParamName= applicationDeviceDescription
|ParamType=String
|ParamRequired=
|ParamDescription=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:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</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;">"Content"</span>: <span style="color: #219;">""</span>
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName= challengeCode
|ParamType=String
|ParamRequired=required
|ParamDescription=Challenge returned by the RegisterTrustedDeviceChallenge method
}}
{{Api_Parameter|
ParamName= applicationDeviceId
|ParamType=String
|ParamRequired=
|ParamDescription=Unique identifier of the device that will be running the paired application.
}}
{{Api_Parameter|
ParamName= applicationDeviceTypeId
|ParamType=int
|ParamRequired=
|ParamDescription=Application device type id. For example for the rPVR application, it should 8601, as defined in the GVP_DEVICES_TYPES table.
}}
{{Api_Parameter|
ParamName= applicationDeviceName
|ParamType=int
|ParamRequired=
|ParamDescription=Friendly name of the device that will be running the paired application.
}}
{{Api_Parameter|
ParamName= applicationDeviceDescription
|ParamType=String
|ParamRequired=
|ParamDescription=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:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</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;">"Content"</span>: <span style="color: #219;">""</span>
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
