Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_DataType_Spec |Description=Represents one field in the user registration form. |Members= {{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10" {{!}}- s..."
{{Api_DataType_Spec
|Description=Represents one field in the user registration form.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Registration field
{{!}}- valign="top"
! '''Title'''
{{!}} String
{{!}} The title for the registration field that will be shown to end users
{{!}}- valign="top"
! '''Type'''
{{!}} int
{{!}} Type of registration field (enumeration). See [[UNIAPI_Specification#RegistrationFieldType|RegistrationFieldType]] enumeration for more information
{{!}}- valign="top"
! '''Values'''
{{!}} Array of [[RegistrationFieldValues|RegistrationFieldValues]]
{{!}} Contains an array of [[RegistrationFieldValues|RegistrationFieldValues]] (GVP_REGISTRATION_FIELDS_VALUES) associated with this registration field
{{!}}- valign="top"
! '''Required'''
{{!}} bool
{{!}} Indicates if the Registration field is mandatory to be filled or not during registration or can be left empty.
{{!}}- valign="top"
! '''ValidationRegex'''
{{!}} String
{{!}} Regex to be applied in the client application to verify that the registration field value provided by the user follows the format specified. Regular Expression for client-side validation is optional. Usage of these is recommended for optimal client experience, but not required. The API will not apply this validation.
{{!}}- valign="top"
! '''Field'''
{{!}} int
{{!}} Registration Required Field Type Enum value. See [[UNIAPI_Specification#RegistrationRequiredFieldType|RegistrationRequiredFieldType]] enumeration for more information
{{!}}- valign="top"
! '''Position'''
{{!}} int
{{!}} Display order for presenting the registration field to the user
{{!}}- valign="top"
! '''ValidationMask'''
{{!}} String
{{!}} Mask that should be used to put a mask on the field, for easy viewing of the user on what format the field will be filled. Example ''“999.999.999-99”''
{{!}}- valign="top"
! '''CustomFieldKey'''
{{!}} String
{{!}} Custom field key configured that uniquely identifies a custom field
{{!}}- valign="top"
! '''CanModify'''
{{!}} bool
{{!}} Indicates if the Registration Field can be used in Registration Field Modification operations. See [[ModifyUser]] method for more information.
{{!}}- valign="top"
! '''Parent'''
{{!}} Parent Registration Field
{{!}} Contains information regarding the parent of this Registration Field. The values contained are:
* '''ParentID (int)'''ID of the parent RegistrationField
* '''Mandatory (bool)''': Boolean indicating if the field is mandatory
* '''Visible (bool)''': Boolean indicating if the field is visible to the end user
{{!}}- valign="top"
! '''DescriptionParent'''
{{!}} String
{{!}} Text that should be displayed to the end user when linking the registration field with its parent
{{!}}- valign="top"
! '''IsBlocking'''
{{!}} bool
{{!}} Indicates that registration should be blocked if this current field is a single selection and its value is true
{{!}}- valign="top"
! '''IsBlockingMessage'''
{{!}} String
{{!}} Text to be shown to the end user when blocking the registration
{{!}}- valign="top"
! '''Mandatory'''
{{!}} bool
{{!}} Indicates if the field is mandatory for registration
{{!}}- valign="top"
! '''ShowKeyboard'''
{{!}} bool
{{!}} Indicates if the application should show a keyboard when the user tries to type this registration field
{{!}}}
|Example=
{
: "ID": 1101,
: "Title": "Gender",
: "Type": 3,
: "Values": [
: {
:: "Title": "Femenino",
:: "Value": "2"
: },
: {
:: "Title": "Masculino",
:: "Value": "1"
: }
: ],
: "Required": false,
: "ValidationRegex": "",
: "Field": 7,
: "Position": 17,
: "ValidationMask": "",
: "CustomFieldKey": "Gender",
: "CanModify": true,
: "Parent":
: {
:: "ParentID": 0,
:: "Mandatory": false,
:: "Visible": true
: },
: "DescriptionParent": "",
: "IsBlocking": false,
: "IsBlockingMessage": "",
: "Mandatory": false,
: "ShowKeyboard": false
}
|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 data type implementaton
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[RegistrationFieldValues|RegistrationFieldValues]] data type
* [[UNIAPI_Specification#Registration Service| RegistrationService]] methods
}}
|Description=Represents one field in the user registration form.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Registration field
{{!}}- valign="top"
! '''Title'''
{{!}} String
{{!}} The title for the registration field that will be shown to end users
{{!}}- valign="top"
! '''Type'''
{{!}} int
{{!}} Type of registration field (enumeration). See [[UNIAPI_Specification#RegistrationFieldType|RegistrationFieldType]] enumeration for more information
{{!}}- valign="top"
! '''Values'''
{{!}} Array of [[RegistrationFieldValues|RegistrationFieldValues]]
{{!}} Contains an array of [[RegistrationFieldValues|RegistrationFieldValues]] (GVP_REGISTRATION_FIELDS_VALUES) associated with this registration field
{{!}}- valign="top"
! '''Required'''
{{!}} bool
{{!}} Indicates if the Registration field is mandatory to be filled or not during registration or can be left empty.
{{!}}- valign="top"
! '''ValidationRegex'''
{{!}} String
{{!}} Regex to be applied in the client application to verify that the registration field value provided by the user follows the format specified. Regular Expression for client-side validation is optional. Usage of these is recommended for optimal client experience, but not required. The API will not apply this validation.
{{!}}- valign="top"
! '''Field'''
{{!}} int
{{!}} Registration Required Field Type Enum value. See [[UNIAPI_Specification#RegistrationRequiredFieldType|RegistrationRequiredFieldType]] enumeration for more information
{{!}}- valign="top"
! '''Position'''
{{!}} int
{{!}} Display order for presenting the registration field to the user
{{!}}- valign="top"
! '''ValidationMask'''
{{!}} String
{{!}} Mask that should be used to put a mask on the field, for easy viewing of the user on what format the field will be filled. Example ''“999.999.999-99”''
{{!}}- valign="top"
! '''CustomFieldKey'''
{{!}} String
{{!}} Custom field key configured that uniquely identifies a custom field
{{!}}- valign="top"
! '''CanModify'''
{{!}} bool
{{!}} Indicates if the Registration Field can be used in Registration Field Modification operations. See [[ModifyUser]] method for more information.
{{!}}- valign="top"
! '''Parent'''
{{!}} Parent Registration Field
{{!}} Contains information regarding the parent of this Registration Field. The values contained are:
* '''ParentID (int)'''ID of the parent RegistrationField
* '''Mandatory (bool)''': Boolean indicating if the field is mandatory
* '''Visible (bool)''': Boolean indicating if the field is visible to the end user
{{!}}- valign="top"
! '''DescriptionParent'''
{{!}} String
{{!}} Text that should be displayed to the end user when linking the registration field with its parent
{{!}}- valign="top"
! '''IsBlocking'''
{{!}} bool
{{!}} Indicates that registration should be blocked if this current field is a single selection and its value is true
{{!}}- valign="top"
! '''IsBlockingMessage'''
{{!}} String
{{!}} Text to be shown to the end user when blocking the registration
{{!}}- valign="top"
! '''Mandatory'''
{{!}} bool
{{!}} Indicates if the field is mandatory for registration
{{!}}- valign="top"
! '''ShowKeyboard'''
{{!}} bool
{{!}} Indicates if the application should show a keyboard when the user tries to type this registration field
{{!}}}
|Example=
{
: "ID": 1101,
: "Title": "Gender",
: "Type": 3,
: "Values": [
: {
:: "Title": "Femenino",
:: "Value": "2"
: },
: {
:: "Title": "Masculino",
:: "Value": "1"
: }
: ],
: "Required": false,
: "ValidationRegex": "",
: "Field": 7,
: "Position": 17,
: "ValidationMask": "",
: "CustomFieldKey": "Gender",
: "CanModify": true,
: "Parent":
: {
:: "ParentID": 0,
:: "Mandatory": false,
:: "Visible": true
: },
: "DescriptionParent": "",
: "IsBlocking": false,
: "IsBlockingMessage": "",
: "Mandatory": false,
: "ShowKeyboard": false
}
|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 data type implementaton
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[RegistrationFieldValues|RegistrationFieldValues]] data type
* [[UNIAPI_Specification#Registration Service| RegistrationService]] methods
}}
