Difference between revisions of "ModifyTrustedDevice"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=This method can change the information from a TrustedDevice already registered. |Parameters= {{Api_Parameter| ParamName=token |ParamType=Strin...") |
|||
Line 27: | Line 27: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A text to identify the device by a friendly name on the list. | |ParamDescription=A text to identify the device by a friendly name on the list. | ||
+ | }} | ||
+ | {{Api_Parameter| | ||
+ | ParamName=notificationToken | ||
+ | |ParamType=String | ||
+ | |ParamRequired=optional | ||
+ | |ParamDescription=The token to identify the device on the notification service. Send empty to disable current token. | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
Line 108: | Line 114: | ||
{{!}} 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:42, 1 July 2015
Description
This method can change the information from a TrustedDevice already registered.
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. Send empty to disable current token.
- enabled (bool, optional)
- Set the status of the device, true for enabled or false for disabled.
- deviceExternalId (String, optional)
- deviceManufacturer (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
- DeviceAlreadyRegisteredToOtherUserException
- ReachedMaximumNumberOfDevicesException
- DeviceIsNotRegisteredToTheAuthenticatedUserException
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 |