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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/Location.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/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v5/Common.xsd (at Common.xsd)

Declared Namespaces

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

Global Declarations

Element: locationList

Name locationList
Type LocationList
Nillable no
Abstract no
Documentation A list of locations (could be ATM's, branches, etc.).
JSON Instance Representation
{locationList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"location" : Location , [0..*] ?
locationList}
Schema Component Representation
<xs:element name="locationList" type="LocationList"/>
top

Global Definitions

Complex Type: AdditionalDataList

Name AdditionalDataList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"additionalDataList" : common:ValuePair , [0..*]
}
Schema Component Representation
<xs:complexType name="AdditionalDataList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="additionalDataList" type="common:ValuePair" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: Location

Name Location
Abstract no
JSON Instance Representation
{
"locationId" : LocationId , [0..1] ?
"name" : xs:string , [0..1] ?
"distance" : common:Distance , [0..1] ?
"type" : LocationType , [0..1] ?
"address" : common:Address , [0..1] ?
"phone" : contact:Phone , [0..1] ?
"mapUrl" : xs:anyURI , [0..1] ?
"network" : xs:string , [0..1] ?
"depositTaking" : DepositTaking , [0..1] ?
"locationHoursList" : LocationHoursList , [0..1] ?
"servicesList" : ServicesList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Location">
<xs:sequence>
<xs:element name="locationId" type="LocationId" minOccurs="0" maxOccurs="1"/>
<xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="distance" type="common:Distance" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="LocationType" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="common:Address" minOccurs="0" maxOccurs="1"/>
<xs:element name="phone" type="contact:Phone" minOccurs="0" maxOccurs="1"/>
<xs:element name="mapUrl" type="xs:anyURI" minOccurs="0" maxOccurs="1"/>
<xs:element name="network" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="depositTaking" type="DepositTaking" minOccurs="0" maxOccurs="1"/>
<xs:element name="locationHoursList" type="LocationHoursList" minOccurs="0" maxOccurs="1"/>
<xs:element name="servicesList" type="ServicesList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LocationHours

Name LocationHours
Abstract no
JSON Instance Representation
{
"locationHoursType" : LocationHoursType , [0..1] ?
"description" : xs:string , [0..1]
"dayOfTheWeek" : common:DayOfTheWeek , [0..1]
"openTime" : xs:time , [0..1]
"closeTime" : xs:time , [0..1]
"closedAllDay" : xs:boolean , [0..1]
"openAllDay" : xs:boolean , [0..1]
}
Schema Component Representation
<xs:complexType name="LocationHours">
<xs:sequence>
<xs:element name="locationHoursType" type="LocationHoursType" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="dayOfTheWeek" type="common:DayOfTheWeek" minOccurs="0" maxOccurs="1"/>
<xs:element name="openTime" type="xs:time" minOccurs="0" maxOccurs="1"/>
<xs:element name="closeTime" type="xs:time" minOccurs="0" maxOccurs="1"/>
<xs:element name="closedAllDay" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="openAllDay" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LocationHoursList

Name LocationHoursList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"locationHours" : LocationHours , [0..*]
}
Schema Component Representation
<xs:complexType name="LocationHoursList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="locationHours" type="LocationHours" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: LocationIdList

Name LocationIdList
Abstract no
Documentation The list of location IDs that should have their associated location data either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"locationId" : LocationId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="LocationIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="locationId" type="LocationId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: LocationList

Name LocationList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"location" : Location , [0..*] ?
}
Schema Component Representation
<xs:complexType name="LocationList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="location" type="Location" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: LocationTypeList

Name LocationTypeList
Abstract no
Documentation The list of location types that should have their associated location data either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"locationType" : LocationType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="LocationTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="locationType" type="LocationType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ServicesList

Name ServicesList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"servicesList" : common:ValuePair , [0..*]
}
Schema Component Representation
<xs:complexType name="ServicesList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="servicesList" type="common:ValuePair" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: DepositTaking

Name DepositTaking
Content
  • Base XSD Type: boolean
Documentation Whether or not this location supports taking deposits.
Schema Component Representation
<xs:simpleType name="DepositTaking">
<xs:restriction base="xs:boolean"/>
</xs:simpleType>
top

Simple Type: LocationHoursType

Name LocationHoursType
Content
  • Base XSD Type: string
  • value comes from list: {'Lobby'|'DriveUp'|'ATM'|'Other'}
Documentation An optional indicator of the type of hours being described, i.e. lobby hours, drive-up hours, etc.
Schema Component Representation
<xs:simpleType name="LocationHoursType">
<xs:restriction base="xs:string">
<xs:enumeration value="Lobby"/>
<xs:enumeration value="DriveUp"/>
<xs:enumeration value="ATM"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: LocationId

Name LocationId
Content
  • Base XSD Type: string
Documentation A unique identifier for the location.
Schema Component Representation
<xs:simpleType name="LocationId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: LocationType

Name LocationType
Content
  • Base XSD Type: string
  • value comes from list: {'ATM'|'SharedATM'|'Branch'|'SharedBranch'|'Kiosk'|'Other'}
Documentation The type of location (e.g. ATM, branch).
Schema Component Representation
<xs:simpleType name="LocationType">
<xs:restriction base="xs:string">
<xs:enumeration value="ATM"/>
<xs:enumeration value="SharedATM"/>
<xs:enumeration value="Branch"/>
<xs:enumeration value="SharedBranch"/>
<xs:enumeration value="Kiosk"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top