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

Table of Contents

top

Schema Document Properties

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

Name errorList
Type ErrorList
Nillable no
Abstract no
Documentation The error collection/array contains all the errors returned when a service point was called.
JSON Instance Representation
{errorList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"error" : Error , [0..*] ?
errorList}
Schema Component Representation
<xs:element name="errorList" type="ErrorList"/>
top

Global Definitions

Complex Type: Error

Name Error
Abstract no
Documentation A collection of fields that represents an individual error that occurred when a service point was called.
JSON Instance Representation
{
"code" : Code , [1] ?
"type" : Type , [1] ?
"subCode" : xs:integer , [0..1] ?
"message" : xs:string , [0..1] ?
"substitutionList" : SubstitutionList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Error">
<xs:sequence>
<xs:element name="code" type="Code" minOccurs="1" maxOccurs="1"/>
<xs:element name="type" type="Type" minOccurs="1" maxOccurs="1"/>
<xs:element name="subCode" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="message" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="substitutionList" type="SubstitutionList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ErrorList

Name ErrorList
Abstract no
Documentation The error collection/array contains all the errors returned when a service point was called.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"error" : Error , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ErrorList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="error" type="Error" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Substitution

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

Complex Type: SubstitutionList

Name SubstitutionList
Abstract no
JSON Instance Representation
{
"substitution" : Substitution , [0..*] ?
}
Schema Component Representation
<xs:complexType name="SubstitutionList">
<xs:sequence>
<xs:element name="substitution" type="Substitution" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: Code

Name Code
Content
  • Base XSD Type: integer
  • value comes from list: {'300'|'302'|'400'|'401'|'402'|'403'|'404'|'409'|'411'|'412'|'413'|'415'|'422'|'423'|'424'|'425'|'426'|'429'|'430'|'431'|'432'|'433'|'434'|'435'|'436'|'437'|'438'|'439'|'440'|'441'|'442'|'443'|'444'|'445'|'475'|'476'|'497'|'498'|'499'|'503'}
Documentation Standard CUFX code returned by the service point. The documentation contains the standard message to return. When '%s' is in the message, it should be replaced with additional details relative to the message content.
Schema Component Representation
<xs:simpleType name="Code">
<xs:restriction base="xs:integer">
<xs:enumeration value="300"/>
<xs:enumeration value="302"/>
<xs:enumeration value="400"/>
<xs:enumeration value="401"/>
<xs:enumeration value="402"/>
<xs:enumeration value="403"/>
<xs:enumeration value="404"/>
<xs:enumeration value="409"/>
<xs:enumeration value="411"/>
<xs:enumeration value="412"/>
<xs:enumeration value="413"/>
<xs:enumeration value="415"/>
<xs:enumeration value="422"/>
<xs:enumeration value="423"/>
<xs:enumeration value="424"/>
<xs:enumeration value="425"/>
<xs:enumeration value="426"/>
<xs:enumeration value="429"/>
<xs:enumeration value="430"/>
<xs:enumeration value="431"/>
<xs:enumeration value="432"/>
<xs:enumeration value="433"/>
<xs:enumeration value="434"/>
<xs:enumeration value="435"/>
<xs:enumeration value="436"/>
<xs:enumeration value="437"/>
<xs:enumeration value="438"/>
<xs:enumeration value="439"/>
<xs:enumeration value="440"/>
<xs:enumeration value="441"/>
<xs:enumeration value="442"/>
<xs:enumeration value="443"/>
<xs:enumeration value="444"/>
<xs:enumeration value="445"/>
<xs:enumeration value="475"/>
<xs:enumeration value="476"/>
<xs:enumeration value="497"/>
<xs:enumeration value="498"/>
<xs:enumeration value="499"/>
<xs:enumeration value="503"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Type

Name Type
Content
  • Base XSD Type: integer
  • value comes from list: {'0'|'100'|'200'|'300'|'310'|'320'|'400'|'500'}
Documentation Standard CUFX error type returned by the service point which indicates the level/category of the error. Value 0 indicates success.
Schema Component Representation
<xs:simpleType name="Type">
<xs:restriction base="xs:integer">
<xs:enumeration value="0"/>
<xs:enumeration value="100"/>
<xs:enumeration value="200"/>
<xs:enumeration value="300"/>
<xs:enumeration value="310"/>
<xs:enumeration value="320"/>
<xs:enumeration value="400"/>
<xs:enumeration value="500"/>
</xs:restriction>
</xs:simpleType>
top