ClientProfileFieldSubcategory Data Type

A client subcategory is a group of generally related profile fields, owned by a client.

Properties
name data type description
displayName string The label of the subcategory
fields array of ClientProfileField Fields that belong to this subcategory
displayOrder number The order to display this subcategory in relation to other subcategories.
hidden boolean Should this field be hidden from the user?
multipleInstances boolean Are multiple instances of this subcategory allowed? In other words, can the user enter values for this subcategory, like multiple credit cards or passports.
headerText string
profileFieldSubcategoryId number
Properties inherited from BaseHibernateEntity
id number The unique internal ID of the object.
version number For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation A list of constraint violations, if any, that this object has.

Example

{
  "displayName" : "...",
  "fields" : [ {
    "inputType" : {
      "code" : "...",
      "name" : "...",
      "dropdown" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "fieldType" : {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "displayName" : "...",
    "displayOrder" : 12345,
    "hidden" : true,
    "readOnly" : true,
    "defaultValue" : "...",
    "selectValues" : [ {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "required" : true,
    "requiredInGroup" : true,
    "minLength" : 12345,
    "maxLength" : 12345,
    "shouldMask" : true,
    "maskBeginIndex" : 12345,
    "maskEndIndex" : 12345,
    "phoneType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "addressType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "customFieldName" : "...",
    "transform" : "...",
    "preferred" : true,
    "encrypted" : true,
    "fieldVisibility" : {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "setOnUserCreation" : true,
    "composite" : true,
    "childFields" : [ { }, { } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "inputType" : {
      "code" : "...",
      "name" : "...",
      "dropdown" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "fieldType" : {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "displayName" : "...",
    "displayOrder" : 12345,
    "hidden" : true,
    "readOnly" : true,
    "defaultValue" : "...",
    "selectValues" : [ {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "required" : true,
    "requiredInGroup" : true,
    "minLength" : 12345,
    "maxLength" : 12345,
    "shouldMask" : true,
    "maskBeginIndex" : 12345,
    "maskEndIndex" : 12345,
    "phoneType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "addressType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "customFieldName" : "...",
    "transform" : "...",
    "preferred" : true,
    "encrypted" : true,
    "fieldVisibility" : {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "setOnUserCreation" : true,
    "composite" : true,
    "childFields" : [ { }, { } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "displayOrder" : 12345,
  "hidden" : true,
  "multipleInstances" : true,
  "headerText" : "...",
  "profileFieldSubcategoryId" : 12345,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}