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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Activity.xsd
Version 4.5.Revision:1062
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/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v4/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v4/CredentialGroup.xsd (at CredentialGroup.xsd)
    • http://cufxstandards.com/v4/Party.xsd (at Party.xsd)
    • http://cufxstandards.com/v4/Relationship.xsd (at Relationship.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/Activity.xsd
xml http://www.w3.org/XML/1998/namespace
account http://cufxstandards.com/v4/Account.xsd
common http://cufxstandards.com/v4/Common.xsd
contact http://cufxstandards.com/v4/Contact.xsd
credential http://cufxstandards.com/v4/CredentialGroup.xsd
party http://cufxstandards.com/v4/Party.xsd
relationship http://cufxstandards.com/v4/Relationship.xsd
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/Activity.xsd" version="4.5.$Revision$: 1062 $" elementFormDefault="qualified">
<xs:import namespace="http://cufxstandards.com/v4/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/CredentialGroup.xsd" schemaLocation="CredentialGroup.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Party.xsd" schemaLocation="Party.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Relationship.xsd" schemaLocation="Relationship.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: activityList

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

Global Definitions

Complex Type: Activity

Name Activity
Abstract no
Documentation General purpose definition describing physical or electronic activity.
JSON Instance Representation
{
"activityId" : ActivityId , [0..1] ?
"previousActivityId" : xs:string , [0..*] ?
"externalActivityId" : xs:string , [0..1] ?
"activityRelatedTo" : RelatedToGroups , [0..1] ?
"activityStatus" : ActivityStatus , [0..1] ?
"activityType" : ActivityType , [0..1] ?
"activityName" : xs:string , [0..1] ?
"activityShortDescription" : xs:string , [0..1] ?
"activityDescription" : xs:string , [0..1] ?
"activityFieldImpactedList" : ActivityFieldImpactedList , [0..1] ?
"creator" : Creator , [0..1] ?
"activityNoteList" : common:NoteList , [0..1] ?
"credentialTypesRequiredList" : credential:CredentialTypeList , [0..1] ?
"credentialsProvidedList" : credential:CredentialGroupList , [0..1] ?
"activityDateTime" : xs:dateTime , [0..1] ?
"activityAmount" : common:Money , [0..1] ?
"activityCreationDateTime" : xs:dateTime , [0..1] ?
"activityModifiedDateTime" : xs:dateTime , [0..1] ?
"activityRequestedDateTime" : xs:dateTime , [0..1] ?
"activityDueDateTime" : xs:dateTime , [0..1] ?
"activityStartDateTime" : xs:dateTime , [0..1] ?
"activityCompletedDateTime" : xs:dateTime , [0..1] ?
"activityArchivedDatetime" : xs:dateTime , [0..1] ?
"activityDeletedDateTime" : xs:dateTime , [0..1] ?
"activityIpAddress" : common:IpAddress , [0..1] ?
"activityScheduled" : ActivityScheduled , [0..1] ?
"activityCustomData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Activity">
<xs:sequence>
<xs:element name="activityId" type="ActivityId" minOccurs="0" maxOccurs="1"/>
<xs:element name="previousActivityId" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="externalActivityId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityRelatedTo" type="RelatedToGroups" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityStatus" type="ActivityStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityType" type="ActivityType" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityShortDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityFieldImpactedList" type="ActivityFieldImpactedList" minOccurs="0" maxOccurs="1"/>
<xs:element name="creator" type="Creator" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityNoteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
<xs:element name="credentialTypesRequiredList" type="credential:CredentialTypeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="credentialsProvidedList" type="credential:CredentialGroupList" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityCreationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityModifiedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityRequestedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityDueDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityStartDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityCompletedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityArchivedDatetime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityDeletedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityIpAddress" type="common:IpAddress" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityScheduled" type="ActivityScheduled" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityCustomData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ActivityFieldImpacted

Name ActivityFieldImpacted
Abstract no
Documentation Elements detailing the nature of change to a given field.
JSON Instance Representation
{
"activityFieldId" : xs:string , [0..1] ?
"activityFieldName" : xs:string , [0..1] ?
"activityFieldDataType" : xs:string , [0..1] ?
"activityFieldPreviousValue" : xs:string , [0..1] ?
"activityFieldNewValue" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ActivityFieldImpacted">
<xs:sequence>
<xs:element name="activityFieldId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityFieldName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityFieldDataType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityFieldPreviousValue" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityFieldNewValue" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ActivityFieldImpactedList

Name ActivityFieldImpactedList
Abstract no
Documentation The collection/array of Fields impacted by an activity.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"activityFieldImpacted" : ActivityFieldImpacted , [0..*]
}
Schema Component Representation
<xs:complexType name="ActivityFieldImpactedList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="activityFieldImpacted" type="ActivityFieldImpacted" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ActivityId

Name ActivityId
Abstract no
Documentation A unique value (or values) used to identify one and only one activity within the repository. Some activity systems do not have a concept of a unique key but a concept of a combined key to access values in the back end system 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
{
"activityUniqueId" : xs:string , [0..1] ?
"activityIdKeyValueList" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ActivityId">
<xs:sequence>
<xs:element name="activityUniqueId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="activityIdKeyValueList" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ActivityIdList

Name ActivityIdList
Abstract no
Documentation Collection of activity 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. -->
"activityId" : ActivityId , [0..*]
}
Schema Component Representation
<xs:complexType name="ActivityIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="activityId" type="ActivityId" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ActivityList

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

Complex Type: ActivityStatusList

Name ActivityStatusList
Abstract no
Documentation Collection of activity statuses 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. -->
"activityStatus" : ActivityStatus , [0..*]
}
Schema Component Representation
<xs:complexType name="ActivityStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="activityStatus" type="ActivityStatus" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ActivityTypeList

Name ActivityTypeList
Abstract no
Documentation Collection of activity 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. -->
"activityType" : ActivityType , [0..*]
}
Schema Component Representation
<xs:complexType name="ActivityTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="activityType" type="ActivityType" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CreatorList

Name CreatorList
Abstract no
Documentation Collection of creators 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. -->
"activityType" : ActivityType , [0..*]
}
Schema Component Representation
<xs:complexType name="CreatorList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="activityType" type="ActivityType" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RelatedToGroups

Name RelatedToGroups
Abstract no
Documentation List of contacts, parties, relationships and accounts related to this request. The lowest level will "override" the high levels. The highest level items are used as defaults if the lower level items are not provided. Additionally, if contacts, parties, relationships or accounts are created as a result of the request, they can be included in the "RelatedTo" fields.
JSON Instance Representation
{
"contactIdList" : contact:ContactIdList , [0..1] ?
"partyIdList" : party:PartyIdList , [0..1] ?
"unknownPartyList" : party:PartyList , [0..1] ?
"relationshipIdList" : relationship:RelationshipIdList , [0..1] ?
"accountIdList" : account:AccountIdList , [0..1] ?
"accountIdentificationList" : account:AccountIdentificationList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RelatedToGroups">
<xs:sequence>
<xs:element name="contactIdList" type="contact:ContactIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyIdList" type="party:PartyIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="unknownPartyList" type="party:PartyList" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipIdList" type="relationship:RelationshipIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdList" type="account:AccountIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountIdentificationList" type="account:AccountIdentificationList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: ActivityScheduled

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

Simple Type: ActivityStatus

Name ActivityStatus
Content
  • Base XSD Type: string
  • value comes from list: {'New'|'Assigned'|'InProgressActive'|'InProgressInactive'|'Completed'|'Cancelled'|'OnHold'}
Documentation Status of the activity within request to indicate how the activity is progressing from a workflow standpoint.
Schema Component Representation
<xs:simpleType name="ActivityStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="New"/>
<xs:enumeration value="Assigned"/>
<xs:enumeration value="InProgressActive"/>
<xs:enumeration value="InProgressInactive"/>
<xs:enumeration value="Completed"/>
<xs:enumeration value="Cancelled"/>
<xs:enumeration value="OnHold"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: ActivityType

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

Simple Type: Creator

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