Difference between revisions of "RegisterUser"

From Gvp-public
Jump to navigation Jump to search
Line 20: Line 20:
 
{{Api_Parameter|
 
{{Api_Parameter|
 
ParamName= userData
 
ParamName= userData
|ParamType=Array
+
|ParamType= Object
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription= TODO
+
|ParamDescription= Json Object with all required fields for registration
 
}}
 
}}
  

Revision as of 09:00, 8 February 2016

Description

Register the user using the data sent int the userData parameter. This method only can be used by instance that has configured NonTelefonicaUser or Both.

This method can be used by anonymous user.

Parameters

  • deviceType (int, required)
The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
  • instanceId (int, required)
The number (ID) of one instance that represent an OB registered in this environment. The same of the user has been registered.
  • userData (Object, required)
Json Object with all required fields for registration


Returns

Returns a JSON object containing a True for successful.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": true

}


Exceptions

  • MissingRequiredRegistrationFieldException (21)
  • MinimumAgeRequiredForRegistrationException (152)
  • UserAlreadyRegisteredException (41)


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


See also