Difference between revisions of "RegisterUser"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Register the user using the data sent int the userData parameter. This method only can be used by instance that has configured NonTelefonicaUser...") |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 20: | Line 20: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName= userData | ParamName= userData | ||
| − | |ParamType=Array | + | |ParamType= Array |
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Array of registration fields for registration: Example: userData=[{"ID":259, "Value":"Jose Manuel"},{"ID":262, "Value":"uniapi_test_159570@mailinator.com"},{"ID":260, "Value":"Escartin"},{"ID":261, "Value":"123456"},{"ID":268, "Value":"2"},{"ID":267, "Value":"Adress"}] |
}} | }} | ||
| Line 38: | Line 38: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * MissingRequiredRegistrationFieldException (21) |
| + | * MinimumAgeRequiredForRegistrationException (152) | ||
| + | * UserAlreadyRegisteredException (41) | ||
| + | * NeedsEmailAccountValidation (257) | ||
| + | |||
|Cache= | |Cache= | ||
| Line 59: | Line 63: | ||
|SeeAlso= | |SeeAlso= | ||
| + | [[ModifyUser]] | ||
}} | }} | ||
Latest revision as of 13:52, 30 March 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 (Array, required)
- Array of registration fields for registration: Example: userData=[{"ID":259, "Value":"Jose Manuel"},{"ID":262, "Value":"uniapi_test_159570@mailinator.com"},{"ID":260, "Value":"Escartin"},{"ID":261, "Value":"123456"},{"ID":268, "Value":"2"},{"ID":267, "Value":"Adress"}]
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)
- NeedsEmailAccountValidation (257)
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 |
