editor
725
edits
Changes
Jump to navigation
Jump to search
RegisterTrustedDeviceChallenge (view source)
Revision as of 14:12, 22 July 2014
, 14:12, 22 July 2014Created page with "{{Api_Method_Spec| Description=Register a new device in the Trusted Device list. To use this method, the user should be logged. Returns a TrustedDeviceChallenge. |Parameters=..."
{{Api_Method_Spec|
Description=Register a new device in the Trusted Device list. To use this method, the user should be logged.
Returns a TrustedDeviceChallenge.
|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=trustedDeviceTypeId
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type id from the device that wants to register. This device typeID should be previously registered on the MiB Tools.
}}
{{Api_Parameter|
ParamName=trustedDeviceId
|ParamType=String
|ParamRequired=required
|ParamDescription=The string that represent some unique information from device and could be used to register a unique id for the instance.
}}
{{Api_Parameter|
ParamName=friendlyName
|ParamType=String
|ParamRequired=required
|ParamDescription=A text to identify the device by a friendly name on the list.
}}
{{Api_Parameter|
ParamName=deviceModel
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName= deviceOperatingSystem
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=macAddress
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=clientVersion
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a TrustedDeviceChallenge.
'''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;">Object TrustedDeviceChallenge</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=Register a new device in the Trusted Device list. To use this method, the user should be logged.
Returns a TrustedDeviceChallenge.
|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=trustedDeviceTypeId
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type id from the device that wants to register. This device typeID should be previously registered on the MiB Tools.
}}
{{Api_Parameter|
ParamName=trustedDeviceId
|ParamType=String
|ParamRequired=required
|ParamDescription=The string that represent some unique information from device and could be used to register a unique id for the instance.
}}
{{Api_Parameter|
ParamName=friendlyName
|ParamType=String
|ParamRequired=required
|ParamDescription=A text to identify the device by a friendly name on the list.
}}
{{Api_Parameter|
ParamName=deviceModel
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName= deviceOperatingSystem
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=macAddress
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=clientVersion
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a TrustedDeviceChallenge.
'''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;">Object TrustedDeviceChallenge</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=
}}
