editor
725
edits
Changes
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..."
{{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 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=
{{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=deviceExternalId
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=deviceManufacturer
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{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 bool answer that represent if the action occur well or not.
'''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;">true</span>
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[InvalidDeviceTypeException]]
* [[ReachedMaximumNumberOfDevicesException]]
* [[DeviceAlreadyRegisteredToTheAuthenticatedUserException]]
* [[DeviceAlreadyRegisteredToOtherUserException]]
|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.
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=
{{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=deviceExternalId
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=deviceManufacturer
|ParamType=String
|ParamRequired=optional
|ParamDescription=
}}
{{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 bool answer that represent if the action occur well or not.
'''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;">true</span>
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[InvalidDeviceTypeException]]
* [[ReachedMaximumNumberOfDevicesException]]
* [[DeviceAlreadyRegisteredToTheAuthenticatedUserException]]
* [[DeviceAlreadyRegisteredToOtherUserException]]
|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=
}}
