Documentation for HeaderData

Table of Contents

Master schema documentation file: HeaderData.xsd.html

top

Schema Document Properties

Target Namespace http://4psa.com/Common.xsd/2.0.0
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.

Declared Namespaces

Prefix Namespace
Default namespace http://4psa.com/Common.xsd/2.0.0
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://4psa.com/Common.xsd/2.0.0" elementFormDefault="qualified" id="Common">
...
</xs:schema>
top

Global Definitions

Complex Type: delObject

Super-types: None
Sub-types: None
Name delObject
Abstract no
Documentation Delete operation response object type
XML Instance Representation
<...>
<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</...>
Schema Component Representation
<xs:complexType name="delObject">
<xs:sequence>
<xs:element name="items" type=" xs:integer " minOccurs="0"/>
<xs:element name="result" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="success"/>
<xs:enumeration value="partial"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: diskSpace

Super-types: None
Sub-types: None
Name diskSpace
Abstract no
Documentation Disk space data
XML Instance Representation
<...>
<used> float </used> [0..1]
<total> unlimitedUFloat </total> [0..1]
</...>
Schema Component Representation
<xs:complexType name="diskSpace">
<xs:sequence>
<xs:element name="used" type=" float " minOccurs="0"/>
<xs:element name="total" type=" unlimitedUFloat " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: notice

Super-types: None
Sub-types: None
Name notice
Used by (from the same schema document) Complex Type updateObject
Abstract no
Documentation Notice type
XML Instance Representation
<...>
<message> text </message> [0..1]
<code> text </code> [0..1]
</...>
Schema Component Representation
<xs:complexType name="notice">
<xs:sequence>
<xs:element name="message" type=" text " minOccurs="0"/>
<xs:element name="code" type=" text " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: unlimitedDate

Super-types: xs:date < unlimitedDate (by extension)
Sub-types: None
Name unlimitedDate
Abstract no
Documentation Unlimited attribute on date type
XML Instance Representation
<...
unlimited="anySimpleType [0..1]">
xs:date
</...>
Schema Component Representation
<xs:complexType name="unlimitedDate">
<xs:simpleContent>
<xs:extension base=" xs:date ">
<xs:attribute name="unlimited" default="true"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: unlimitedUFloat

Super-types: float < float (by restriction) < unlimitedUFloat (by extension)
Sub-types: None
Name unlimitedUFloat
Used by (from the same schema document) Complex Type diskSpace
Abstract no
Documentation Unlimited attribute on float type
XML Instance Representation
<...
unlimited="anySimpleType [0..1]">
xs:float
</...>
Schema Component Representation
<xs:complexType name="unlimitedUFloat">
<xs:simpleContent>
<xs:extension base=" xs:float ">
<xs:attribute name="unlimited" default="true"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: unlimitedUInt

Super-types: unsignedInt < unsignedInt (by restriction) < unlimitedUInt (by extension)
Sub-types: None
Name unlimitedUInt
Abstract no
Documentation unlimited attribute on integer type
XML Instance Representation
<...
unlimited=" boolean [0..1]">
xs:unsignedInt
</...>
Schema Component Representation
<xs:complexType name="unlimitedUInt">
<xs:simpleContent>
<xs:extension base=" xs:unsignedInt ">
<xs:attribute name="unlimited" type=" boolean " default="true"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: updateObject

Super-types: None
Sub-types: None
Name updateObject
Abstract no
Documentation Update operation response object type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="updateObject">
<xs:sequence>
<xs:element name="ID" type=" positiveInteger " minOccurs="0" maxOccurs="10"/>
<xs:element name="result" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="success"/>
<xs:enumeration value="partial"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="notice" type=" notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: base64

Super-types: xs:base64Binary < base64 (by restriction)
Sub-types: None
Name base64
Content
  • Base XSD Type: base64Binary
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="base64">
<xs:restriction base=" xs:base64Binary ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: boolean

Super-types: boolean < boolean (by restriction)
Sub-types:
Name boolean
Used by (from the same schema document) Complex Type unlimitedUInt
Content
  • Base XSD Type: boolean
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="boolean">
<xs:restriction base=" xs:boolean ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: code

Super-types: string < string (by restriction) < code (by restriction)
Sub-types: None
Name code
Content
  • Base XSD Type: string
  • length <= 2
  • Whitespace policy: collapse
Documentation Two-character code type.Used for languages and countries.
Schema Component Representation
<xs:simpleType name="code">
<xs:restriction base=" xs:string ">
<xs:maxLength value="2"/>
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: dateTime

Super-types: dateTime < dateTime (by restriction)
Sub-types:
Name dateTime
Content
  • Base XSD Type: dateTime
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="dateTime">
<xs:restriction base=" xs:dateTime ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: domain

Super-types: string < string (by restriction) < domain (by restriction)
Sub-types: None
Name domain
Content
  • Base XSD Type: string
  • pattern = (((([a-zA-Z0-9]+)|(([a-zA-Z0-9]+)\-?)+([a-zA-Z0-9]+))\.)+(([a-zA-Z0-9]+)|(([a-zA-Z0-9]+)\-?)+([a-zA-Z0-9]+)))
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="domain">
<xs:restriction base=" xs:string ">
<xs:whiteSpace value="collapse"/>
<xs:pattern value="(((([a-zA-Z0-9]+)|(([a-zA-Z0-9]+)\-?)+([a-zA-Z0-9]+))\.)+(([a-zA-Z0-9]+)|(([a-zA-Z0-9]+)\-?)+([a-zA-Z0-9]+)))"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: double

Super-types: double < double (by restriction)
Sub-types:
Name double
Content
  • Base XSD Type: double
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="double">
<xs:restriction base=" xs:double ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: email

Super-types: string < string (by restriction) < email (by restriction)
Sub-types: None
Name email
Content
  • Base XSD Type: string
  • pattern = [\-\+_\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?
  • length >= 3
Schema Component Representation
<xs:simpleType name="email">
<xs:restriction base=" xs:string ">
<xs:minLength value="3"/>
<xs:maxLength value="255"/>
<xs:pattern value="[\-\+_\p{L}\p{N}\.]*@([\p{L}\p{N}][\-\p{L}\p{N}]*\.)*[\p{L}][\-\p{L}\p{N}]*\.?"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: emptyFloat

Super-types: string < string (by restriction) < emptyFloat (by restriction)
Sub-types: None
Name emptyFloat
Content
  • Base XSD Type: string
  • pattern = ([0-9]+)\.([0-9]+)?
Schema Component Representation
<xs:simpleType name="emptyFloat">
<xs:restriction base=" xs:string ">
<xs:pattern value="([0-9]+)\.([0-9]+)?"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: float

Super-types: float < float (by restriction)
Sub-types:
Name float
Used by (from the same schema document) Complex Type diskSpace
Content
  • Base XSD Type: float
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="float">
<xs:restriction base=" xs:float ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: integer

Super-types: integer < integer (by restriction)
Sub-types:
Name integer
Content
  • Base XSD Type: integer
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="integer">
<xs:restriction base=" xs:integer ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ip

Super-types: string < string (by restriction) < ip (by restriction)
Sub-types: None
Name ip
Content
  • Base XSD Type: string
  • pattern = ([01]?\p{Nd}{1,2}|2([0-4]\p{Nd}|5[0-5]))(\.([01]?\p{Nd}{1,2}|2([0-4]\p{Nd}|5[0-5]))){3}
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="ip">
<xs:restriction base=" xs:string ">
<xs:whiteSpace value="collapse"/>
<xs:pattern value="([01]?\p{Nd}{1,2}|2([0-4]\p{Nd}|5[0-5]))(\.([01]?\p{Nd}{1,2}|2([0-4]\p{Nd}|5[0-5]))){3}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: password

Super-types: string < string (by restriction) < password (by restriction)
Sub-types: None
Name password
Content
  • Base XSD Type: string
  • length >= 4
Schema Component Representation
<xs:simpleType name="password">
<xs:restriction base=" xs:string ">
<xs:minLength value="4"/>
<xs:maxLength value="64"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: pcode

Super-types: string < string (by restriction) < pcode (by restriction)
Sub-types: None
Name pcode
Content
  • Base XSD Type: string
  • length <= 10
Documentation Postal/zip code type
Schema Component Representation
<xs:simpleType name="pcode">
<xs:restriction base=" xs:string ">
<xs:maxLength value="10"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: positiveInteger

Super-types: positiveInteger < positiveInteger (by restriction)
Sub-types:
Name positiveInteger
Used by (from the same schema document) Complex Type updateObject
Content
  • Base XSD Type: positiveInteger
  • total no. of digits = 4
  • Whitespace policy: collapse
Documentation Object ID
Schema Component Representation
<xs:simpleType name="positiveInteger">
<xs:restriction base=" xs:positiveInteger ">
<xs:whiteSpace value="collapse"/>
<xs:totalDigits value="4"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: rule

Super-types: string < string (by restriction) < rule (by restriction)
Sub-types: None
Name rule
Content
  • Base XSD Type: string
  • pattern = [*XZN\-\.\[\]\d]+
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="rule">
<xs:restriction base=" xs:string ">
<xs:whiteSpace value="collapse"/>
<xs:pattern value="[*XZN\-\.\[\]\d]+"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: short

Super-types: short < short (by restriction)
Sub-types:
Name short
Content
  • Base XSD Type: short
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="short">
<xs:restriction base=" xs:short ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: string

Super-types: string < string (by restriction)
Sub-types:
Name string
Content
  • Base XSD Type: string
  • length <= 255
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="string">
<xs:restriction base=" xs:string ">
<xs:maxLength value="255"/>
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: text

Super-types: string < string (by restriction) < text (by restriction)
Sub-types: None
Name text
Used by (from the same schema document) Complex Type notice , Complex Type notice
Content
  • Base XSD Type: string
  • Whitespace policy: preserve
Schema Component Representation
<xs:simpleType name="text">
<xs:restriction base=" xs:string ">
<xs:whiteSpace value="preserve"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: unsignedInt

Super-types: unsignedInt < unsignedInt (by restriction)
Sub-types:
Name unsignedInt
Content
  • Base XSD Type: unsignedInt
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="unsignedInt">
<xs:restriction base=" xs:unsignedInt ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: unsignedShort

Super-types: unsignedShort < unsignedShort (by restriction)
Sub-types:
Name unsignedShort
Content
  • Base XSD Type: unsignedShort
  • Whitespace policy: collapse
Schema Component Representation
<xs:simpleType name="unsignedShort">
<xs:restriction base=" xs:unsignedShort ">
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Generated by <oXygen/> XML Editor using a modified version of xs3p that adds schema diagrams and chunking support. Last modified: