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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/UserMessage.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/User.xsd (at User.xsd)
    • http://cufxstandards.com/v4/UserFilter.xsd (at UserFilter.xsd)
    • http://cufxstandards.com/v4/MessageContext.xsd (at MessageContext.xsd)

Declared Namespaces

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

Global Declarations

Element: userMessage

Name userMessage
Type UserMessage
Nillable no
Abstract no
Documentation All values that can be sent in a user message. Contains message context, user filter and user 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
{userMessage
"messageContext" : messageContext:MessageContext , [0..1] ?
"userFilter" : userFilter:UserFilter , [0..1] ?
"userList" : user:UserList , [0..1] ?
userMessage}
Schema Component Representation
<xs:element name="userMessage" type="UserMessage"/>
top

Global Definitions

Complex Type: UserMessage

Name UserMessage
Abstract no
Documentation All values that can be sent in a user message. Contains message context, user filter and and user 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] ?
"userFilter" : userFilter:UserFilter , [0..1] ?
"userList" : user:UserList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="UserMessage">
<xs:sequence>
<xs:element name="messageContext" type="messageContext:MessageContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="userFilter" type="userFilter:UserFilter" minOccurs="0" maxOccurs="1"/>
<xs:element name="userList" type="user:UserList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top