A client subcategory is a group of generally related profile fields, owned by a client.
| name | data type | type | namespace | min/max occurs | description |
|---|---|---|---|---|---|
| displayName | string | element | 0/1 | The label of the subcategory | |
| displayOrder | int | element | 0/1 | The order to display this subcategory in relation to other subcategories. | |
| fields | list of clientProfileField | element | 0/unbounded | Fields that belong to this subcategory | |
| headerText | string | element | 0/1 | ||
| boolean | element | 0/1 | Should this field be hidden from the user? | ||
| multipleInstances | boolean | element | 0/1 | Are multiple instances of this subcategory allowed? In other words, can the user enter values for this subcategory, like multiple credit cards or passports. | |
| profileFieldSubcategoryId | long | element | 0/1 | ||
Properties inherited from baseHibernateEntity |
|||||
| id | long | element | 0/1 | The unique internal ID of the object. | |
| version | long | element | 0/1 | For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions. | |
Properties inherited from baseEntity |
|||||
| violations | list of simpleViolation | element | 0/unbounded | A list of constraint violations, if any, that this object has. | |
Example
<clientProfileFieldSubcategory>
<displayName>...</displayName>
<fields>
<inputType>
<code>...</code>
<name>...</name>
<dropdown>...</dropdown>
</inputType>
<fieldType>
<propertyName>...</propertyName>
<displayName>...</displayName>
<type/>
<displayOrder>...</displayOrder>
<hidden>...</hidden>
<readonly>...</readonly>
<defaultValue>...</defaultValue>
<required>...</required>
<requiredInGroup>...</requiredInGroup>
<fullDisplayName>...</fullDisplayName>
<shouldMask>...</shouldMask>
<maskBeginIndex>...</maskBeginIndex>
<maskEndIndex>...</maskEndIndex>
<minLength>...</minLength>
<maxLength>...</maxLength>
<custom>...</custom>
<customFieldName>...</customFieldName>
<fieldGroup/>
<preferred>...</preferred>
<encrypted>...</encrypted>
<fieldVisibility/>
<setOnUserCreation>...</setOnUserCreation>
<composite>...</composite>
<childFields/>
</fieldType>
<displayName>...</displayName>
<displayOrder>...</displayOrder>
<hidden>...</hidden>
<readOnly>...</readOnly>
<defaultValue>...</defaultValue>
<selectValues>
<displayName>...</displayName>
<value>...</value>
</selectValues>
<required>...</required>
<requiredInGroup>...</requiredInGroup>
<minLength>...</minLength>
<maxLength>...</maxLength>
<shouldMask>...</shouldMask>
<maskBeginIndex>...</maskBeginIndex>
<maskEndIndex>...</maskEndIndex>
<addressType>
<type>...</type>
<code>...</code>
</addressType>
<customFieldName>...</customFieldName>
<transform>...</transform>
<preferred>...</preferred>
<encrypted>...</encrypted>
<fieldVisibility>
<name>...</name>
<description>...</description>
</fieldVisibility>
<setOnUserCreation>...</setOnUserCreation>
<composite>...</composite>
<childFields/>
<id>...</id>
<version>...</version>
</fields>
<displayOrder>...</displayOrder>
<hidden>...</hidden>
<multipleInstances>...</multipleInstances>
<headerText>...</headerText>
<profileFieldSubcategoryId>...</profileFieldSubcategoryId>
<id>...</id>
<version>...</version>
<violations/>
</clientProfileFieldSubcategory>