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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/SystemStatus.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/SystemStatus.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/SystemStatus.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: systemStatusList

Name systemStatusList
Type SystemStatusList
Nillable no
Abstract no
Documentation The system status collection/array list contains all the system statuses that are authorized for access at the Institution based on applied filters.
JSON Instance Representation
{systemStatusList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"systemState" : SystemState , [0..*]
systemStatusList}
Schema Component Representation
<xs:element name="systemStatusList" type="SystemStatusList"/>
top

Global Definitions

Complex Type: SystemState

Name SystemState
Abstract no
Documentation This returns the status of the system, commonly used for online systems attempting to determine if the system is available for real-time transactions.
JSON Instance Representation
{
"systemName" : SystemName , [0..1] ?
"systemId" : SystemId , [0..1] ?
"systemStatus" : SystemStatus , [0..1] ?
"systemDescription" : xs:string , [0..1] ?
"isBusinessDay" : xs:boolean , [0..1] ?
"nextBusinessDate" : xs:date , [0..1] ?
"previousBusinessDate" : xs:date , [0..1] ?
"postingDate" : xs:date , [0..1] ?
"systemCutOffDateTime" : xs:dateTime , [0..1] ?
"systemStatusCustomData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="SystemState">
<xs:sequence>
<xs:element name="systemName" type="SystemName" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemId" type="SystemId" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemStatus" type="SystemStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="isBusinessDay" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="nextBusinessDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="previousBusinessDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="postingDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemCutOffDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemStatusCustomData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: SystemStatusList

Name SystemStatusList
Abstract no
Documentation The system status collection/array list contains all the system statuses that are authorized for 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. -->
"systemState" : SystemState , [0..*]
}
Schema Component Representation
<xs:complexType name="SystemStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="systemState" type="SystemState" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: SystemId

Name SystemId
Content
  • Base XSD Type: string
Documentation The identification value of the system within the financial institution that is providing the status.
Schema Component Representation
<xs:simpleType name="SystemId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: SystemName

Name SystemName
Content
  • Base XSD Type: string
Documentation The name of the system within the financial institution that is providing the status.
Schema Component Representation
<xs:simpleType name="SystemName">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: SystemStatus

Name SystemStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Online'|'Offline'|'MemoPost'}
Documentation Current status of the system, i.e. online, offline, etc.
Schema Component Representation
<xs:simpleType name="SystemStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Online"/>
<xs:enumeration value="Offline"/>
<xs:enumeration value="MemoPost"/>
</xs:restriction>
</xs:simpleType>
top