A profile value is the value that a user has entered to be submitted into their profile in the GDS or OBE. You can think of the client profile fields as questions and that the profile value is the answer to that question. This version does not encrypt the data in an effort to maximize use of database space.
| name | data type | constraints | description |
|---|---|---|---|
| field | ClientProfileField | The field that this value is for. | |
| value | string | The value. | |
| masked | boolean | required boolean | |
| defaultValue | boolean | required boolean | |
Properties inherited from ProfileValue |
|||
| field | ClientProfileField | ||
| value | string | ||
| masked | boolean | required boolean | |
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
{
"field" : {
"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,
"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" : "..."
} ]
},
"value" : "...",
"masked" : true,
"defaultValue" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}