Field - Schema Documentation - V4.5.Revision
Documents generated: 4/9/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Field.xsd
Version 4.5.Revision
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/Field.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/Field.xsd" version="4.5.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: fieldList

Name fieldList
Type FieldList
Nillable no
Abstract no
Documentation List of fields to provide for a given interaction.
JSON Instance Representation
{fieldList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"field" : Field , [0..*] ?
fieldList}
Schema Component Representation
<xs:element name="fieldList" type="FieldList"/>
top

Element: fieldRequirementList

Name fieldRequirementList
Type FieldRequirementList
Nillable no
Abstract no
Documentation List of data that a party must provide for a given field.
JSON Instance Representation
{fieldRequirementList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldRequirement" : FieldRequirement , [0..*] ?
fieldRequirementList}
Schema Component Representation
<xs:element name="fieldRequirementList" type="FieldRequirementList"/>
top

Global Definitions

Complex Type: Field

Name Field
Abstract no
JSON Instance Representation
{
"fieldId" : FieldId , [0..1] ?
"fieldName" : xs:string , [0..1] ?
"fieldType" : FieldType , [0..1] ?
"fieldPrompt" : xs:string , [0..1] ?
"fieldValue" : xs:string , [0..1] ?
"isFieldRequired" : xs:boolean , [0..1] ?
"fieldRequirementList" : FieldRequirementList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Field">
<xs:sequence>
<xs:element name="fieldId" type="FieldId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldType" type="FieldType" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldPrompt" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldValue" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="isFieldRequired" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldRequirementList" type="FieldRequirementList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: FieldIdList

Name FieldIdList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldId" : FieldId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fieldId" type="FieldId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FieldList

Name FieldList
Abstract no
Documentation List of fields to provide for a given interaction.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"field" : Field , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="field" type="Field" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FieldRequirement

Name FieldRequirement
Abstract no
JSON Instance Representation
{
"fieldRequirementId" : FieldRequirementId , [0..1] ?
"fieldTechnicalRequirement" : xs:string , [0..1] ?
"fieldSelection" : xs:string , [0..1] ?
"fieldRequirementDescription" : xs:string , [0..1] ?
"fieldRequirementType" : FieldRequirementType , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="FieldRequirement">
<xs:sequence>
<xs:element name="fieldRequirementId" type="FieldRequirementId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldTechnicalRequirement" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldSelection" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldRequirementDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fieldRequirementType" type="FieldRequirementType" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: FieldRequirementIdList

Name FieldRequirementIdList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldRequirementId" : FieldRequirementId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldRequirementIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fieldRequirementId" type="FieldRequirementId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FieldRequirementList

Name FieldRequirementList
Abstract no
Documentation List of data that a user provides
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldRequirement" : FieldRequirement , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldRequirementList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fieldRequirement" type="FieldRequirement" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FieldRequirementTypeList

Name FieldRequirementTypeList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldRequirementType" : FieldRequirementType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldRequirementTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fieldRequirementType" type="FieldRequirementType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FieldTypeList

Name FieldTypeList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fieldType" : FieldType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FieldTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fieldType" type="FieldType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: FieldId

Name FieldId
Content
  • Base XSD Type: string
Documentation Identifier for the field.
Schema Component Representation
<xs:simpleType name="FieldId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: FieldRequirementId

Name FieldRequirementId
Content
  • Base XSD Type: string
Documentation Identifier for the field requirement.
Schema Component Representation
<xs:simpleType name="FieldRequirementId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: FieldRequirementType

Name FieldRequirementType
Content
  • Base XSD Type: string
Documentation The format of the content of fieldRequirement. Example: Java Script, Pattern, HTML, C# snippet.
Schema Component Representation
<xs:simpleType name="FieldRequirementType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: FieldType

Name FieldType
Content
  • Base XSD Type: string
Documentation The expected type for the field. May be a Boolean, String, GUID, or other data types.
Schema Component Representation
<xs:simpleType name="FieldType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top