ClientProfileField Data Type

A client profile field is a field that a client chooses to have in their profile. It could be a travel preference, or some extra information like a cost center.

Properties
name data type description
inputType ProfileInputType The input type of the field. Like NUMERIC or CHAR.
fieldType ProfileField The field type of the field. Like if it is a first name or last name. This determines where in the profile the value is entered.
displayName string The name of the field as displayed to the users.
displayOrder number The order in which the field is displayed to the user.
hidden boolean Whether or not the field is hidden to users.
readOnly boolean Whether or not the field is read only to users.
defaultValue string
selectValues array of ClientProfileSelectValue The available values the client has determined are acceptable entries for this field.
required boolean Is this field required?
requiredInGroup boolean Is this field required in its group?
minLength number The minimum length of the field.
maxLength number The max length of the field.
shouldMask boolean Should this field be masked when its returned to the user?
maskBeginIndex number The begin index of the field mask.
maskEndIndex number The end index of the mask.
phoneType ProfilePhoneType The phone type of this field.
addressType ProfileAddressType The address type for this field
customFieldName string The sync name for a custom field.
transform string An optional transform field to indicate how to transform the value
preferred boolean Is this field preferred over fields of the same type? At the moment this only applies to phone numbers.
encrypted boolean
fieldVisibility ProfileFieldVisibility
setOnUserCreation boolean
composite boolean
childFields array of ClientProfileField
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

{
  "inputType" : {
    "code" : "...",
    "name" : "...",
    "dropdown" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fieldType" : {
    "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" : "..."
    } ]
  },
  "displayName" : "...",
  "displayOrder" : 12345,
  "hidden" : true,
  "readOnly" : true,
  "defaultValue" : "...",
  "selectValues" : [ {
    "displayName" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "displayName" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "required" : true,
  "requiredInGroup" : true,
  "minLength" : 12345,
  "maxLength" : 12345,
  "shouldMask" : true,
  "maskBeginIndex" : 12345,
  "maskEndIndex" : 12345,
  "phoneType" : {
    "type" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "addressType" : {
    "type" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "customFieldName" : "...",
  "transform" : "...",
  "preferred" : true,
  "encrypted" : true,
  "fieldVisibility" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "setOnUserCreation" : true,
  "composite" : true,
  "childFields" : [ {
    "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" : "..."
    } ]
  } ],
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}