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.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
addressType profileAddressType element 0/1   The address type for this field
childFields list of clientProfileField element 0/unbounded    
composite boolean element 1/1 required boolean  
customFieldName string element 0/1   The sync name for a custom field.
defaultValue string element 0/1    
displayName string element 0/1   The name of the field as displayed to the users.
displayOrder int element 0/1   The order in which the field is displayed to the user.
encrypted boolean element 1/1 required boolean  
fieldType profileField element 0/1   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.
fieldVisibility profileFieldVisibility element 0/1    
hidden boolean element 1/1 required boolean Whether or not the field is hidden to users.
inputType profileInputType element 0/1   The input type of the field. Like NUMERIC or CHAR.
maskBeginIndex long element 0/1   The begin index of the field mask.
maskEndIndex long element 0/1   The end index of the mask.
maxLength long element 0/1   The max length of the field.
minLength long element 0/1   The minimum length of the field.
preferred boolean element 0/1   Is this field preferred over fields of the same type? At the moment this only applies to phone numbers.
readOnly boolean element 1/1 required boolean Whether or not the field is read only to users.
required boolean element 1/1 required boolean Is this field required?
requiredInGroup boolean element 1/1 required boolean Is this field required in its group?
selectValues list of clientProfileSelectValue element 0/unbounded   The available values the client has determined are acceptable entries for this field.
setOnUserCreation boolean element 0/1    
shouldMask boolean element 0/1   Should this field be masked when its returned to the user?
transform string element 0/1   An optional transform field to indicate how to transform the value
Properties inherited from baseHibernateEntity
id long element 0/1   The unique internal ID of the object.
version long element 0/1   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<clientProfileField>
  <inputType>
    <code>...</code>
    <name>...</name>
    <dropdown>...</dropdown>
    <id>...</id>
    <version>...</version>
  </inputType>
  <fieldType>
    <propertyName>...</propertyName>
    <displayName>...</displayName>
    <type>
      <code>...</code>
      <name>...</name>
      <dropdown>...</dropdown>
    </type>
    <displayOrder>...</displayOrder>
    <hidden>...</hidden>
    <readonly>...</readonly>
    <defaultValue>...</defaultValue>
    <required>...</required>
    <requiredInGroup>...</requiredInGroup>
    <fullDisplayName>...</fullDisplayName>
    <shouldMask>...</shouldMask>
    <maskBeginIndex>...</maskBeginIndex>
    <maskEndIndex>...</maskEndIndex>
    <minLength>...</minLength>
    <maxLength>...</maxLength>
    <custom>...</custom>
    <customFieldName>...</customFieldName>
    <fieldGroup>
      <code>...</code>
    </fieldGroup>
    <preferred>...</preferred>
    <encrypted>...</encrypted>
    <fieldVisibility>
      <name>...</name>
      <description>...</description>
    </fieldVisibility>
    <setOnUserCreation>...</setOnUserCreation>
    <composite>...</composite>
    <childFields/>
    <id>...</id>
    <version>...</version>
  </fieldType>
  <displayName>...</displayName>
  <displayOrder>...</displayOrder>
  <hidden>...</hidden>
  <readOnly>...</readOnly>
  <defaultValue>...</defaultValue>
  <selectValues>
    <displayName>...</displayName>
    <value>...</value>
    <id>...</id>
    <version>...</version>
  </selectValues>
  <required>...</required>
  <requiredInGroup>...</requiredInGroup>
  <minLength>...</minLength>
  <maxLength>...</maxLength>
  <shouldMask>...</shouldMask>
  <maskBeginIndex>...</maskBeginIndex>
  <maskEndIndex>...</maskEndIndex>
  <addressType>
    <type>...</type>
    <code>...</code>
    <id>...</id>
    <version>...</version>
  </addressType>
  <customFieldName>...</customFieldName>
  <transform>...</transform>
  <preferred>...</preferred>
  <encrypted>...</encrypted>
  <fieldVisibility>
    <name>...</name>
    <description>...</description>
    <id>...</id>
    <version>...</version>
  </fieldVisibility>
  <setOnUserCreation>...</setOnUserCreation>
  <composite>...</composite>
  <childFields/>
  <id>...</id>
  <version>...</version>
  <violations/>
</clientProfileField>