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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/AppFilter.xsd
Version 4.5.Revision:1257
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/App.xsd (at App.xsd)
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/AppFilter.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
app http://cufxstandards.com/v4/App.xsd
common http://cufxstandards.com/v4/Common.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/AppFilter.xsd" version="4.5.$Revision$: 1257 $" elementFormDefault="qualified">
<xs:import namespace="http://cufxstandards.com/v4/App.xsd" schemaLocation="App.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: appFilter

Name appFilter
Type AppFilter
Nillable no
Abstract no
Documentation The list of filter options for services requesting App data. An App is a program compiled and deployed to a computer.
JSON Instance Representation
{appFilter
"appIdList" : app:AppIdList , [0..1] ?
"appTypeList" : app:AppTypeList , [0..1] ?
"vendorIdList" : common:VendorIdList , [0..1] ?
"appHashList" : app:AppHashList , [0..1] ?
"isAppHashValidated" : xs:boolean , [0..1] ?
"appParameterIdList" : app:AppParameterIdList , [0..1] ?
"parameterNameList" : app:ParameterNameList , [0..1] ?
"parameterScopeList" : app:ParameterScopeList , [0..1] ?
"parameterTypeList" : app:ParameterTypeList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
appFilter}
Schema Component Representation
<xs:element name="appFilter" type="AppFilter"/>
top

Global Definitions

Complex Type: AppFilter

Name AppFilter
Abstract no
Documentation The list of filter options for services requesting app data. The options can be used in combination or by themselves. It is up to the data source to either return the data requested or return a standard error identifying why the request was rejected.
JSON Instance Representation
{
"appIdList" : app:AppIdList , [0..1] ?
"appTypeList" : app:AppTypeList , [0..1] ?
"vendorIdList" : common:VendorIdList , [0..1] ?
"appHashList" : app:AppHashList , [0..1] ?
"isAppHashValidated" : xs:boolean , [0..1] ?
"appParameterIdList" : app:AppParameterIdList , [0..1] ?
"parameterNameList" : app:ParameterNameList , [0..1] ?
"parameterScopeList" : app:ParameterScopeList , [0..1] ?
"parameterTypeList" : app:ParameterTypeList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="AppFilter">
<xs:sequence>
<xs:element name="appIdList" type="app:AppIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="appTypeList" type="app:AppTypeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="vendorIdList" type="common:VendorIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="appHashList" type="app:AppHashList" minOccurs="0" maxOccurs="1"/>
<xs:element name="isAppHashValidated" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="appParameterIdList" type="app:AppParameterIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="parameterNameList" type="app:ParameterNameList" minOccurs="0" maxOccurs="1"/>
<xs:element name="parameterScopeList" type="app:ParameterScopeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="parameterTypeList" type="app:ParameterTypeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top