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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Contact.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)
    • http://cufxstandards.com/v4/ISOCountryCodeType-V2006.xsd (at ISOCountryCodeType-V2006.xsd)
    • http://cufxstandards.com/v4/Preference.xsd (at Preference.xsd)

Declared Namespaces

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

Global Declarations

Element: contactList

Name contactList
Type ContactList
Nillable no
Abstract no
Documentation The contact list collection/array contains all the contacts points that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{contactList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"contact" : Contact , [0..*] ?
contactList}
Schema Component Representation
<xs:element name="contactList" type="ContactList"/>
top

Global Definitions

Complex Type: Contact

Name Contact
Abstract no
JSON Instance Representation
{
"contactId" : ContactId , [0..1] ?
"contactType" : ContactType , [1] ?
"contactPersonName" : common:PersonName , [0..1] ?
"contactPoint" : ContactPoint , [0..1] ?
"contactPointDescription" : xs:string , [0..1] ?
"timeOfDay" : TimeOfDayType , [0..1] ?
"demonstratedAccess" : DemonstratedAccess , [0..1] ?
"badContactPoint" : xs:boolean , [0..1] ?
"preferenceOrder" : xs:positiveInteger , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"contactDateTimeCreated" : xs:dateTime , [0..1] ?
"contactCreatedBy" : common:UserId , [0..1] ?
"contactDateTimeModified" : xs:dateTime , [0..1] ?
"contactModifiedBy" : common:UserId , [0..1] ?
"contactDateTimeDeleted" : xs:dateTime , [0..1] ?
"contactDeletedBy" : common:UserId , [0..1] ?
"preferenceSettingList" : preference:PreferenceSettingList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Contact">
<xs:sequence>
<xs:element name="contactId" type="ContactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactType" type="ContactType" minOccurs="1" maxOccurs="1"/>
<xs:element name="contactPersonName" type="common:PersonName" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactPoint" type="ContactPoint" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactPointDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="timeOfDay" type="TimeOfDayType" minOccurs="0" maxOccurs="1"/>
<xs:element name="demonstratedAccess" type="DemonstratedAccess" minOccurs="0" maxOccurs="1"/>
<xs:element name="badContactPoint" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="preferenceOrder" type="xs:positiveInteger" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactDateTimeCreated" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactCreatedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactDateTimeModified" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactModifiedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactDateTimeDeleted" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="contactDeletedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="preferenceSettingList" type="preference:PreferenceSettingList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ContactAddress

Name ContactAddress
Abstract no
JSON Instance Representation
{
<!-- 'common:Address' super type was not found in this schema. Some elements and attributes may be missing. -->
"addressType" : AddressType , [0..1] ?
"effectiveDateTime" : xs:dateTime , [0..1] ?
"expirationDateTime" : xs:dateTime , [0..1] ?
"timeAtAddress" : xs:duration , [0..1] ?
"addressVerifyDateTime" : xs:dateTime , [0..1] ?
"otherAddressType" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ContactAddress">
<xs:complexContent>
<xs:extension base="common:Address">
<xs:sequence>
<xs:element name="addressType" type="AddressType" minOccurs="0" maxOccurs="1"/>
<xs:element name="effectiveDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="timeAtAddress" type="xs:duration" minOccurs="0" maxOccurs="1"/>
<xs:element name="addressVerifyDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherAddressType" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ContactIdList

Name ContactIdList
Abstract no
Documentation The list of contact IDs that should have their associated contacts either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"contactId" : ContactId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ContactIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="contactId" type="ContactId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ContactList

Name ContactList
Abstract no
Documentation The contact list collection/array contains all the contacts points, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"contact" : Contact , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ContactList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="contact" type="Contact" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ContactPoint

Name ContactPoint
Abstract no
Documentation Choice of contact point types Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"address" : ContactAddress , [0..1] ?
"phone" : Phone , [0..1] ?
"email" : Email , [0..1] ?
"instantMessage" : InstantMessage , [0..1] ?
"social" : SocialContactPoint , [0..1] ?
"website" : Website , [0..1] ?
"sms" : Phone , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ContactPoint">
<xs:sequence>
<xs:element name="address" type="ContactAddress" minOccurs="0" maxOccurs="1"/>
<xs:element name="phone" type="Phone" minOccurs="0" maxOccurs="1"/>
<xs:element name="email" type="Email" minOccurs="0" maxOccurs="1"/>
<xs:element name="instantMessage" type="InstantMessage" minOccurs="0" maxOccurs="1"/>
<xs:element name="social" type="SocialContactPoint" minOccurs="0" maxOccurs="1"/>
<xs:element name="website" type="Website" minOccurs="0" maxOccurs="1"/>
<xs:element name="sms" type="Phone" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ContactTypeList

Name ContactTypeList
Abstract no
Documentation The list of contact types that should have their associated contacts either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"contactType" : ContactType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ContactTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="contactType" type="ContactType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DemonstratedAccess

Name DemonstratedAccess
Abstract no
Documentation Is a collection of fields that identifies that appropriate access has been demonstrated to receive information electronically for this contact point.
JSON Instance Representation
{
"dateTime" : xs:dateTime , [0..1] ?
"fullName" : xs:string , [0..1] ?
"userName" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DemonstratedAccess">
<xs:sequence>
<xs:element name="dateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="fullName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="userName" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Email

Name Email
Abstract no
JSON Instance Representation
{
"emailType" : EmailType , [0..1] ?
"address" : xs:string , [0..1] ?
"otherEmailType" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Email">
<xs:sequence>
<xs:element name="emailType" type="EmailType" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherEmailType" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: InstantMessage

Name InstantMessage
Abstract no
JSON Instance Representation
{
"messagingService" : xs:string , [0..1] ?
"user" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="InstantMessage">
<xs:sequence>
<xs:element name="messagingService" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="user" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Phone

Name Phone
Abstract no
Documentation Fields related to phone contact points when phone type is selected.
JSON Instance Representation
{
"phoneType" : PhoneType , [0..1] ?
"number" : xs:string , [0..1] ?
"extension" : xs:string , [0..1] ?
"planFormat" : PlanFormat , [0..1] ?
"description" : xs:string , [0..1] ?
"smsRegistered" : xs:boolean , [0..1] ?
"countryCode" : isoCountryCodeType:ISOCountryCodeType , [0..1] ?
"country" : xs:string , [0..1] ?
"otherPhoneType" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Phone">
<xs:sequence>
<xs:element name="phoneType" type="PhoneType" minOccurs="0" maxOccurs="1"/>
<xs:element name="number" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="extension" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="planFormat" type="PlanFormat" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="smsRegistered" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="countryCode" type="isoCountryCodeType:ISOCountryCodeType" minOccurs="0" maxOccurs="1"/>
<xs:element name="country" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherPhoneType" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SocialContactPoint

Name SocialContactPoint
Abstract no
JSON Instance Representation
{
"socialService" : xs:string , [0..1] ?
"user" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SocialContactPoint">
<xs:sequence>
<xs:element name="socialService" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="user" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: Website

Name Website
Abstract no
JSON Instance Representation
{
"sitename" : xs:string , [0..1] ?
"user" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Website">
<xs:sequence>
<xs:element name="sitename" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="user" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: AddressType

Name AddressType
Content
  • Base XSD Type: string
  • value comes from list: {'Home'|'Work'|'Mailing'|'Previous'|'Temporary'|'CTR'|'Other'}
Documentation Classification of an address
Schema Component Representation
<xs:simpleType name="AddressType">
<xs:restriction base="xs:string">
<xs:enumeration value="Home"/>
<xs:enumeration value="Work"/>
<xs:enumeration value="Mailing"/>
<xs:enumeration value="Previous"/>
<xs:enumeration value="Temporary"/>
<xs:enumeration value="CTR"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ContactId

Name ContactId
Content
  • Base XSD Type: string
Documentation Unique identifier within system to uniquely identify this contact point.
Schema Component Representation
<xs:simpleType name="ContactId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: ContactType

Name ContactType
Content
  • Base XSD Type: string
  • value comes from list: {'Address'|'Phone'|'Email'|'InstantMessaging'|'Social'|'Website'|'Other'|'SMS'}
Schema Component Representation
<xs:simpleType name="ContactType">
<xs:restriction base="xs:string">
<xs:enumeration value="Address"/>
<xs:enumeration value="Phone"/>
<xs:enumeration value="Email"/>
<xs:enumeration value="InstantMessaging"/>
<xs:enumeration value="Social"/>
<xs:enumeration value="Website"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="SMS"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: EmailType

Name EmailType
Content
  • Base XSD Type: string
  • value comes from list: {'Home'|'Work'|'Other'}
Documentation The members classification of the email.
Schema Component Representation
<xs:simpleType name="EmailType">
<xs:restriction base="xs:string">
<xs:enumeration value="Home"/>
<xs:enumeration value="Work"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PhoneType

Name PhoneType
Content
  • Base XSD Type: string
  • value comes from list: {'Home'|'Work'|'Mobile'|'Pager'|'Fax'|'Other'}
Documentation The type of phone the number represents. Also considered a classification of the phone.
Schema Component Representation
<xs:simpleType name="PhoneType">
<xs:restriction base="xs:string">
<xs:enumeration value="Home"/>
<xs:enumeration value="Work"/>
<xs:enumeration value="Mobile"/>
<xs:enumeration value="Pager"/>
<xs:enumeration value="Fax"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PlanFormat

Name PlanFormat
Content
  • Base XSD Type: string
  • value comes from list: {'Nanp'|'NanpLessCountryCode'|'OtherInternational'|'NationalNumber'}
Schema Component Representation
<xs:simpleType name="PlanFormat">
<xs:restriction base="xs:string">
<xs:enumeration value="Nanp"/>
<xs:enumeration value="NanpLessCountryCode"/>
<xs:enumeration value="OtherInternational"/>
<xs:enumeration value="NationalNumber"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TimeOfDayType

Name TimeOfDayType
Content
  • Base XSD Type: string
  • value comes from list: {'Afternoon'|'Evening'|'Morning'}
Documentation The best time of day to call contact's phone numbers.
Schema Component Representation
<xs:simpleType name="TimeOfDayType">
<xs:restriction base="xs:string">
<xs:enumeration value="Afternoon"/>
<xs:enumeration value="Evening"/>
<xs:enumeration value="Morning"/>
</xs:restriction>
</xs:simpleType>
top