VT-AdditionalDataFieldsForClientEntity.yaml

      FieldList:
        FieldDefinition:
        - FieldName: "ClientCode"
          FieldType: "String"
          FieldDescription: "The unique VETtrak code of the client, up to 10 characters"
          MaximumLength: "10"
          IsUpdateable: "true"
        - FieldName: "Title"
          FieldType: "String"
          FieldDescription: "The title of the client (Mr, Mrs, Miss, Ms, Dr etc)"
          MaximumLength: "10"
          IsUpdateable: "true"
        - FieldName: "Surname"
          FieldType: "String"
          FieldDescription: "The surname (or single name) of the client"
          MaximumLength: "50"
          IsUpdateable: "true"
        - FieldName: "GivenName"
          FieldType: "String"
          FieldDescription: "The given name of the client. For a single name client,\
            \ this field must be empty"
          MaximumLength: "50"
          IsUpdateable: "true"
        - FieldName: "OtherName"
          FieldType: "String"
          FieldDescription: "The other names of the client, such as middle names.\
            \ For a single name client, this field must be empty"
          MaximumLength: "50"
          IsUpdateable: "true"
        - FieldName: "Gender"
          FieldType: "String"
          FieldDescription: "The gender of the client"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "M"
              ValueDescription: "Male"
            - FieldValue: "F"
              ValueDescription: "Female"
            - FieldValue: "X"
              ValueDescription: "Indeterminate/Intersex/Unspecified"
        - FieldName: "StaffFlag"
          FieldType: "String"
          FieldDescription: "Flag indicating whether the client is a staff member"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "N"
              ValueDescription: "Normal client"
            - FieldValue: "Y"
              ValueDescription: "Staff member"
        - FieldName: "Username"
          FieldType: "String"
          FieldDescription: "The username of the client, for logins"
          MaximumLength: "50"
          IsUpdateable: "true"
        - FieldName: "WebPublishFlag"
          FieldType: "String"
          FieldDescription: "Flag indicating whether the client can have its data\
            \ accessed via the APIs"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "Y"
              ValueDescription: "Is web published"
            - FieldValue: "N"
              ValueDescription: "Is not web published"
        - FieldName: "BirthDate"
          FieldType: "Date"
          FieldDescription: "The client's date of birth"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
        - FieldName: "USI"
          FieldType: "String"
          FieldDescription: "The Unique Student Identifier for the client. When setting,\
            \ must be 10 characters, must be upper case (allowed characters are 2-9,\
            \ and A-Z except I and O), and must have a valid Luhn Mod N check character.\
            \ Use the ValidateUSI function to check whether a USI is valid"
          MaximumLength: "10"
          IsUpdateable: "true"
        - FieldName: "USIExempt"
          FieldType: "String"
          FieldDescription: "Whether the client is exempt from the USI scheme"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "N"
              ValueDescription: "No, not exempt"
            - FieldValue: "Y"
              ValueDescription: "Yes, is exempt. When updating to this value, the\
                \ USI field must also be set to empty"
        - FieldName: "USIVerifyStatus"
          FieldType: "Integer"
          FieldDescription: "The verification status of the client's USI"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "0"
              ValueDescription: "Not verified. The client does not have a USI, or\
                \ it has not been verified with the USI registrar"
            - FieldValue: "1"
              ValueDescription: "Valid. The USI exists on the USI registrar, and the\
                \ client's name and date of birth match the USI registrar's records"
            - FieldValue: "2"
              ValueDescription: "Invalid. The USI does not exist on the USI registrar"
            - FieldValue: "3"
              ValueDescription: "Deactivated. The USI is known, but it is marked as\
                \ deactivated on the USI registrar's records"
            - FieldValue: "4"
              ValueDescription: "Multiple names mismatched. The USI is known, but\
                \ the client's name does not match the USI registrar's records for\
                \ this USI"
            - FieldValue: "5"
              ValueDescription: "Mismatched date of birth. The USI is known, but the\
                \ client's date of birth does not match the USI registrar's records\
                \ for this USI"
            - FieldValue: "6"
              ValueDescription: "First name doesn't match. The USI is known, but the\
                \ client's first name does not match the USI registrar's records for\
                \ this USI"
            - FieldValue: "7"
              ValueDescription: "Surname doesn't match. The USI is known, but the\
                \ client's surname does not match the USI registrar's records for\
                \ this USI"
            - FieldValue: "8"
              ValueDescription: "Single name doesn't match. The USI is known, but\
                \ the client's single name does not match the USI registrar's records\
                \ for this USI"
        - FieldName: "USIVerifyDate"
          FieldType: "Date"
          FieldDescription: "The date that the client's USI was last verified with\
            \ the USI registrar"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
        - FieldName: "AddressType"
          FieldType: "Integer"
          FieldDescription: "The type of the client's address"
          MaximumLength:
            '@nil': "true"
          IsUpdateable: "true"
          ValidValuesList:
            ValidValueDefinition:
            - FieldValue: "0"