GetRegistrationFields
Jump to navigation
Jump to search
Description
Returns the list of RegistrationField objects.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- 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.
- forModifyUser (bool, required)
- If the fields are requested for modify user information this field will be set to true, if the fields are requested for new user registration sent to false/none
Returns
Returns a JSON object containing an array of RegistrationField.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- [ Array of RegistrationField objects ]
}
Exceptions
- InvalidRegistrationConfigurationException (40)
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 |