ProfileValueGroup Data Type

A profile value group binds a collection of profile values. These groups define relationships between multiple profile values. For instance, a group of fields can be processed together when we send them to an OBE or GDS. So when we send process field groups we can identify them as a credit card or passport, etc. This all extends from the idea that all profiles fields only know what they are as individual values, but the profile value group lets us give them an cohesive identity.

Properties
name data type constraints description
member ClientMember   The client member who submitted the profile value.
encryptedValues array of ProfileValueEncrypted   A collection of encrypted profile values that belong to this group.
unencryptedValues array of ProfileValueUnencrypted   A collection of unencrypted profile values that belong to this group.
subcategoryId number   DO NOT USE. UP FOR DEPRECATION.
subcategory ClientProfileFieldSubcategory  
clearExisting boolean required boolean DO NOT USE. UP FOR DEPRECATION.
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

{
  "member" : {
    "employer" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "user" : {
      "answer" : "...",
      "emailed" : true,
      "newUser" : true,
      "temporaryPassword" : "...",
      "question" : "...",
      "obeUserName" : "...",
      "obePassword" : "...",
      "obeSyncId" : "...",
      "created" : 12345,
      "modifiedDate" : 12345,
      "emailedWhen" : 12345,
      "travelgpaLogin" : "...",
      "groups" : [ { }, { } ],
      "active" : true,
      "prefix" : "...",
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "suffix" : "...",
      "email" : "...",
      "tripitAuthorized" : true,
      "supportTitle" : "...",
      "automatedNotifications" : true,
      "enableHotelAttachment" : true,
      "atHomeNotificationMethod" : { },
      "inTravelNotificationMethod" : { },
      "cellPhoneNumber" : "...",
      "userCurrentClient" : { },
      "defaultClient" : { },
      "defaultPlannerGroup" : { },
      "showWelcomeDialog" : true,
      "siteTour" : true,
      "unusedTicketEmail" : true,
      "surveyEmail" : true,
      "wt0EmailEnabled" : true,
      "wt0EmailDaily" : true,
      "wt0EmailDay" : 12345,
      "wt0EmailHour" : 12345,
      "marketingSubscribed" : true,
      "responsive" : true,
      "businessPhoneNumber" : "...",
      "homePhoneNumber" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "primaryClient" : true,
    "gdsName" : "...",
    "obeName" : "...",
    "complete" : true,
    "uploaded" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "encryptedValues" : [ {
    "field" : {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "value" : "...",
    "masked" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "field" : {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "value" : "...",
    "masked" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "unencryptedValues" : [ {
    "field" : {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "value" : "...",
    "masked" : true,
    "defaultValue" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "field" : {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "value" : "...",
    "masked" : true,
    "defaultValue" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "subcategoryId" : 12345,
  "subcategory" : {
    "displayName" : "...",
    "fields" : [ {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "displayOrder" : 12345,
    "hidden" : true,
    "multipleInstances" : true,
    "headerText" : "...",
    "profileFieldSubcategoryId" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "clearExisting" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}