ProductServiceRequest - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/ProductServiceRequest.xsd
Version 5.0.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/v5/Activity.xsd (at Activity.xsd)
    • http://cufxstandards.com/v5/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v5/Document.xsd (at Document.xsd)
    • http://cufxstandards.com/v5/SecureMessage.xsd (at SecureMessage.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/ProductServiceRequest.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
activity http://cufxstandards.com/v5/Activity.xsd
common http://cufxstandards.com/v5/Common.xsd
document http://cufxstandards.com/v5/Document.xsd
secureMessage http://cufxstandards.com/v5/SecureMessage.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/ProductServiceRequest.xsd" version="5.0.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v5/Activity.xsd" schemaLocation="Activity.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Document.xsd" schemaLocation="Document.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/SecureMessage.xsd" schemaLocation="SecureMessage.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: productServiceRequestList

Name productServiceRequestList
Type ProductServiceRequestList
Nillable no
Abstract no
Documentation The product service request list collection/array contains all the product service requests, for instance, that the credential set is authorized to access at the Institution based on applied filters. The product service request may be connected to an existing party, relationship and/or contact. In addition, a product service request may exist without an existing relationship or contact. The product service request, if created without connection to existing party, contact or relationship, could be converted so that it is connected to an existing party, contact and relationship or aids in creating a contact, party and relationship. If created without connection to existing party, etc. then it might be sent to a CRM system for follow up with the contact or pushed to another system after the product service request has been fulfilled.
JSON Instance Representation
{productServiceRequestList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productServiceRequest" : ProductServiceRequest , [0..*] ?
productServiceRequestList}
Schema Component Representation
<xs:element name="productServiceRequestList" type="ProductServiceRequestList"/>
top

Global Definitions

Complex Type: ProductServiceRequest

Name ProductServiceRequest
Abstract no
Documentation The product service request object defines all the fields necessary to define that an existing or potential party is interested in a particular product or service. The product service request can migrate through several statuses as the product service request progresses. To enroll in a product or service please see Application.xsd or ProductServiceEnrollment.xsd.
JSON Instance Representation
{
"productServiceRequestId" : ProductServiceRequestId , [0..1] ?
"requestList" : RequestList , [0..1] ?
"source" : xs:string , [0..1] ?
"status" : ProductServiceStatus , [0..1] ?
"createDateTime" : xs:dateTime , [0..1] ?
"productServiceRequestRelatedTo" : activity:RelatedToGroups , [0..1] ?
"productServiceRequestNoteList" : common:NoteList , [0..1] ?
"productServiceRequestCustomData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ProductServiceRequest">
<xs:sequence>
<xs:element name="productServiceRequestId" type="ProductServiceRequestId" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestList" type="RequestList" minOccurs="0" maxOccurs="1"/>
<xs:element name="source" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="status" type="ProductServiceStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="createDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="productServiceRequestRelatedTo" type="activity:RelatedToGroups" minOccurs="0" maxOccurs="1"/>
<xs:element name="productServiceRequestNoteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
<xs:element name="productServiceRequestCustomData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ProductServiceRequestIdList

Name ProductServiceRequestIdList
Abstract no
Documentation Definition of the list of product service request IDs that can be used by other objects to point to each product service request in a list.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productServiceRequestId" : ProductServiceRequestId , [0..*]
}
Schema Component Representation
<xs:complexType name="ProductServiceRequestIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productServiceRequestId" type="ProductServiceRequestId" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductServiceRequestList

Name ProductServiceRequestList
Abstract no
Documentation The product service request list collection/array contains all the product service requests, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productServiceRequest" : ProductServiceRequest , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductServiceRequestList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productServiceRequest" type="ProductServiceRequest" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductServiceStatusList

Name ProductServiceStatusList
Abstract no
Documentation List of product service request statuses, typically used for filtering.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"status" : ProductServiceStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductServiceStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="status" type="ProductServiceStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Request

Name Request
Abstract no
Documentation An individual request that's part of a larger request of products, services, etc. that the member is requesting.
JSON Instance Representation
{
"requestId" : RequestId , [0..1] ?
"requestItem" : RequestItem , [0..1] ?
"requestStatus" : activity:ActivityStatus , [0..1] ?
"requestedDateTime" : xs:dateTime , [0..1] ?
"dueDateTime" : xs:dateTime , [0..1] ?
"startDateTime" : xs:dateTime , [0..1] ?
"completedDateTime" : xs:dateTime , [0..1] ?
"requestNoteList" : common:NoteList , [0..1] ?
"requestRelatedTo" : activity:RelatedToGroups , [0..1] ?
"activityList" : activity:ActivityList , [0..1] ?
"secureMessageList" : secureMessage:SecureMessageList , [0..1] ?
"documentList" : document:DocumentIdList , [0..1] ?
"requestCustomData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Request">
<xs:sequence>
<xs:element name="requestId" type="RequestId" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestItem" type="RequestItem" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestStatus" type="activity:ActivityStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="dueDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="startDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="completedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestNoteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestRelatedTo" type="activity:RelatedToGroups" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityList" type="activity:ActivityList" minOccurs="0" maxOccurs="1"/>
<xs:element name="secureMessageList" type="secureMessage:SecureMessageList" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentList" type="document:DocumentIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="requestCustomData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RequestItem

Name RequestItem
Abstract no
Documentation A product, service or question related to products and services. Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"productOfInterest" : xs:string , [0..1] ?
"serviceOfInterest" : xs:string , [0..1] ?
"question" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RequestItem">
<xs:sequence>
<xs:element name="productOfInterest" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="serviceOfInterest" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="question" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RequestList

Name RequestList
Abstract no
Documentation A list of products or services that the person is interested in or questions they have about the institution's products and services.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"request" : Request , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RequestList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="request" type="Request" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: ProductServiceRequestId

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

Simple Type: ProductServiceStatus

Name ProductServiceStatus
Content
  • Base XSD Type: string
  • value comes from list: {'New'|'Assigned'|'InDiscussion'|'InProposal'|'VerbalCommitment'|'Converted'|'Lost'|'Other'}
Documentation Status of the product service request to indicate how the product service request is progressing from a workflow standpoint.
Schema Component Representation
<xs:simpleType name="ProductServiceStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="New"/>
<xs:enumeration value="Assigned"/>
<xs:enumeration value="InDiscussion"/>
<xs:enumeration value="InProposal"/>
<xs:enumeration value="VerbalCommitment"/>
<xs:enumeration value="Converted"/>
<xs:enumeration value="Lost"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RequestId

Name RequestId
Content
  • Base XSD Type: string
Documentation Unique identifier for the request.
Schema Component Representation
<xs:simpleType name="RequestId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top