Difference between revisions of "RegisterTrustedDevice"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Register a new device in the Trusted Device list. To use this method, the user should be logged. The device type should be previously registere...") |
|||
| Line 34: | Line 34: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=notificationToken |
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=The token to identify the device on the notification service. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=deviceExternalId |
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| Line 104: | Line 104: | ||
! Change description | ! Change description | ||
! Changes author | ! Changes author | ||
| + | |||
{{!}}- valign="top" | {{!}}- valign="top" | ||
! 1.0 | ! 1.0 | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | |||
| + | {{!}}- valign="top" | ||
| + | ! 3.0 | ||
| + | {{!}} Deprecated Parameters | ||
| + | * deviceManufacturer | ||
| + | New parameter | ||
| + | * notificationToken | ||
| + | {{!}} Ricardo Calvo | ||
| + | |||
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
}} | }} | ||
Revision as of 18:12, 1 July 2015
Description
Register a new device in the Trusted Device list. To use this method, the user should be logged.
The device type should be previously registered on the environment and defined on the instance. The quantity of the device type can't reached the limit defined on the instance settings.
Other requirements, is that the unique DeviceID is global on the platform and can't been currently used by another user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- trustedDeviceTypeId (int, required)
- The device type id from the device that wants to register. This device typeID should be previously registered on the MiB Tools.
- trustedDeviceId (String, required)
- The string that represent some unique information from device and could be used to register a unique id for the instance.
- friendlyName (String, required)
- A text to identify the device by a friendly name on the list.
- notificationToken (String, optional)
- The token to identify the device on the notification service.
- deviceExternalId (String, optional)
- deviceModel (String, optional)
- deviceOperatingSystem (String, optional)
- macAddress (String, optional)
- clientVersion (String, optional)
Returns
Returns a JSON object containing a bool answer that represent if the action occur well or not.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
- AuthenticationRequiredException
- InvalidDeviceTypeException
- ReachedMaximumNumberOfDevicesException
- DeviceAlreadyRegisteredToTheAuthenticatedUserException
- DeviceAlreadyRegisteredToOtherUserException
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 |
| 3.0 | Deprecated Parameters
New parameter
|
Ricardo Calvo |
