ProfileFieldSubcategory Data Type

A profile field subcategory is a collection of fields and field groups that define a specific piece of profile information Examples: Credit Cards, Driver's Licenses, Passports.

Properties
name data type description
displayName string The Human readable name for the Sub Category.
fields array of ProfileField The Fields that belong to this collection. Example Name, Address, Credit Card Number, etc.
displayOrder number The order which we expect the field to be displayed on the form Example: you'd want first name to be lower than last name
hidden boolean A flag that determines whether this sub category should show on the form
multipleInstances boolean A flag that defines whether there can be multiple versions of this collection. Example: A user can have multiple Passports or credit cards
headerText string Up for deprecation. Do Not use.
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" : [ {
    "propertyName" : "...",
    "displayName" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "dropdown" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "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" : {
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "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" : "..."
    } ]
  }, {
    "propertyName" : "...",
    "displayName" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "dropdown" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "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" : {
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "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" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}