PreferenceMessage - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/PreferenceMessage.xsd
Version 5.0.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/v5/MessageContext.xsd (at MessageContext.xsd)
    • http://cufxstandards.com/v5/Preference.xsd (at Preference.xsd)
    • http://cufxstandards.com/v5/PreferenceFilter.xsd (at PreferenceFilter.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/PreferenceMessage.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
messageContext http://cufxstandards.com/v5/MessageContext.xsd
preference http://cufxstandards.com/v5/Preference.xsd
preferenceFilter http://cufxstandards.com/v5/PreferenceFilter.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/PreferenceMessage.xsd" version="5.0.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v5/MessageContext.xsd" schemaLocation="MessageContext.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Preference.xsd" schemaLocation="Preference.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/PreferenceFilter.xsd" schemaLocation="PreferenceFilter.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: preferenceMessage

Name preferenceMessage
Type PreferenceMessage
Nillable no
Abstract no
Documentation All values that can be sent in a preference message. Contains message context, preference filter and a preference list. This is a wrapper used to more easily serialize the complete message. All values are optional. See example specifications for usage.
JSON Instance Representation
{preferenceMessage
"messageContext" : messageContext:MessageContext , [0..1] ?
"preferenceFilter" : preferenceFilter:PreferenceFilter , [0..1] ?
"preferenceList" : preference:PreferenceList , [0..1] ?
preferenceMessage}
Schema Component Representation
<xs:element name="preferenceMessage" type="PreferenceMessage"/>
top

Global Definitions

Complex Type: PreferenceMessage

Name PreferenceMessage
Abstract no
Documentation All values that can be sent in a preference message. Contains message context, preference filter and a preference list. This is a wrapper used to more easily serialize the complete message. All values are optional. See example specifications for usage.
JSON Instance Representation
{
"messageContext" : messageContext:MessageContext , [0..1] ?
"preferenceFilter" : preferenceFilter:PreferenceFilter , [0..1] ?
"preferenceList" : preference:PreferenceList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="PreferenceMessage">
<xs:sequence>
<xs:element name="messageContext" type="messageContext:MessageContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="preferenceFilter" type="preferenceFilter:PreferenceFilter" minOccurs="0" maxOccurs="1"/>
<xs:element name="preferenceList" type="preference:PreferenceList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top