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

Table of Contents

top

Schema Document Properties

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

Name categoryList
Type CategoryList
Nillable no
Abstract no
Documentation The categories collection/array contains all the categories
JSON Instance Representation
{categoryList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"category" : Category , [0..*]
categoryList}
Schema Component Representation
<xs:element name="categoryList" type="CategoryList"/>
top

Global Definitions

Complex Type: Category

Name Category
Abstract no
Documentation General purpose definition describing a categorization.
JSON Instance Representation
{
"categoryId" : CategoryId , [0..1] ?
"categoryName" : xs:string , [0..1] ?
"categoryDescription" : xs:string , [0..1] ?
"categoryType" : CategoryType , [0..1] ?
"isCategoryActive" : xs:boolean , [0..1] ?
"parentCategoryId" : CategoryId , [0..1] ?
"imageId" : ImageId , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Category">
<xs:sequence>
<xs:element name="categoryId" type="CategoryId" minOccurs="0" maxOccurs="1"/>
<xs:element name="categoryName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="categoryDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="categoryType" type="CategoryType" minOccurs="0" maxOccurs="1"/>
<xs:element name="isCategoryActive" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="parentCategoryId" type="CategoryId" minOccurs="0" maxOccurs="1"/>
<xs:element name="imageId" type="ImageId" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CategoryIdList

Name CategoryIdList
Abstract no
Documentation Collection of category IDs to return in a filter request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"categoryId" : CategoryId , [0..*]
}
Schema Component Representation
<xs:complexType name="CategoryIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="categoryId" type="CategoryId" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CategoryList

Name CategoryList
Abstract no
Documentation The categories collection/array contains all the categories for a specified request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"category" : Category , [0..*]
}
Schema Component Representation
<xs:complexType name="CategoryList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="category" type="Category" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CategoryTypeList

Name CategoryTypeList
Abstract no
Documentation Collection of category types to return in a filter request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"categoryType" : CategoryType , [0..*]
}
Schema Component Representation
<xs:complexType name="CategoryTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="categoryType" type="CategoryType" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: CategoryId

Name CategoryId
Content
  • Base XSD Type: string
Documentation An identifier for the category. Must be unique within the list of categories. May be a serial number or letter (1, 2, 3 or A, B, C), a GUID, or other identifier.
Schema Component Representation
<xs:simpleType name="CategoryId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: CategoryType

Name CategoryType
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="CategoryType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: ImageId

Name ImageId
Content
  • Base XSD Type: string
Documentation An identifier for image related to the category
Schema Component Representation
<xs:simpleType name="ImageId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top