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

Table of Contents

top

Schema Document Properties

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

Name ratingsList
Type RatingsList
Nillable no
Abstract no
Documentation Top level element rating array contains all the product or service ratings.
JSON Instance Representation
{ratingsList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"rating" : Rating , [0..*] ?
ratingsList}
Schema Component Representation
<xs:element name="ratingsList" type="RatingsList"/>
top

Global Definitions

Complex Type: Rating

Name Rating
Abstract no
JSON Instance Representation
{
"reviewId" : RatingId , [0..1] ?
"reviewDateTime" : xs:date , [0..1] ?
"reviewerName" : xs:string , [0..1] ?
"productCode" : xs:string , [0..1] ?
"productName" : xs:string , [0..1] ?
"overallRating" : xs:decimal , [0..1] ?
"featureReview" : xs:boolean , [0..1] ?
"recommended" : xs:boolean , [0..1] ?
"reviewSubject" : xs:string , [0..1] ?
"reviewDescription" : xs:string , [0..1] ?
"reviewerEmail" : xs:string , [0..1] ?
"reviewerUserId" : xs:string , [0..1] ?
"reviewerLocation" : xs:string , [0..1] ?
"reviewerAge" : xs:string , [0..1] ?
"reviewerGender" : common:Gender , [0..1] ?
"productDescription" : xs:string , [0..1] ?
"productType" : xs:string , [0..1] ?
"productURL" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Rating">
<xs:sequence>
<xs:element name="reviewId" type="RatingId" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewDateTime" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="productCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="productName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="overallRating" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="featureReview" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="recommended" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewSubject" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerEmail" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerUserId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerLocation" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerAge" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reviewerGender" type="common:Gender" minOccurs="0" maxOccurs="1"/>
<xs:element name="productDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="productType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="productURL" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RatingsList

Name RatingsList
Abstract no
Documentation This is a list of product or service ratings.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"rating" : Rating , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RatingsList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="rating" type="Rating" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: RatingId

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