Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Used by

Table of Contents

Group by:

No namespace

Main schema Attribute.xsd
Annotations
 
Attribute List provides a facility to supply Entity attributes via a separate load file rather than as nodes on the Master Entity Load file.
i.e. CustomerAccount Attributes and be provided in the Customer AccountListSubmit interface or via a separate AttributeListSubmit with its header load filter attribute set to the applicable Entity name.  i.e. LoadFilter = “CustomerAccount” 

The Attribute element is described in the Common Elements section
[ top ]
Included schema CommonElements.xsd
[ top ]
Element AttributeListSubmit
Diagram
Diagram Attribute.tmp#CommonAttributes Attribute.tmp#Attributes Attribute.tmp#Errors
Instance
 
<AttributeListSubmit Culture="en" EndTime="" ErrorCount="0" LoadFilter="" LoadType="" SiteID="" StartTime="" StatusID="" TransactionID="" Transformed="false" Version="">
  <Attributes Version="">{1,1}</Attributes>
  <Errors>{0,1}</Errors>
</AttributeListSubmit>
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]
Element Attributes
Annotations
 
Deprecated at Entity Level..  Please use the separate AttributeList Load File to load entity specific attributes.
Diagram
Diagram Attribute.tmp#Attributes_Version Attribute.tmp#Attribute
Used by
Instance
 
<Attributes Version="">
  <Attribute Deprecated="" Scope="">{0,unbounded}</Attribute>
</Attributes>
Attributes
QName Type Use
Version xs:decimal optional
[ top ]
Element Attribute
Diagram
Diagram Attribute.tmp#Attribute_Deprecated Attribute.tmp#Attribute_Scope Attribute.tmp#Attribute_EntityCode Attribute.tmp#Attribute_Name Attribute.tmp#Attribute_Value
Used by
Element Attributes
Instance
 
<Attribute Deprecated="" Scope="">
  <EntityCode>{0,1}</EntityCode>
  <Name>{1,1}</Name>
  <Value DataType="">{0,1}</Value>
</Attribute>
Attributes
QName Type Use Annotation
Deprecated xs:boolean optional
Scope xs:string optional 
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
[ top ]
Element Attribute / EntityCode
Annotations
 
The code of the entity these attributes belong t  - i.e. ProductItemCode  Field is mandatory if attributes are ssent on a separate file.
Diagram
Diagram
Facets
maxLength 36
[ top ]
Element Attribute / Name
Annotations
 
Name of the Attribute
Diagram
Diagram
[ top ]
Element Attribute / Value
Annotations
 
Value of the Attribute, must be the string representation of the appropriate type
Diagram
Diagram Attribute.tmp#Attribute_Attribute_Value_DataType
Attributes
QName Type Use
DataType xs:string optional
[ top ]
Element Errors
Diagram
Diagram Attribute.tmp#Errors_Error
Used by
Instance
 
<Errors>
  <Error>{0,unbounded}</Error>
</Errors>
[ top ]
Element Errors / Error
Diagram
Diagram Attribute.tmp#Errors_Errors_Error_ErrorCode Attribute.tmp#Errors_Errors_Error_ErrorRef Attribute.tmp#Errors_Errors_Error_ErrorMsg Attribute.tmp#Errors_Errors_Error_AdditionalInfo
Instance
 
<Error>
  <ErrorCode>{1,1}</ErrorCode>
  <ErrorRef>{1,1}</ErrorRef>
  <ErrorMsg>{1,1}</ErrorMsg>
  <AdditionalInfo>{0,1}</AdditionalInfo>
</Error>
[ top ]
Element Errors / Error / ErrorCode
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorRef
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorMsg
Diagram
Diagram
[ top ]
Element Errors / Error / AdditionalInfo
Diagram
Diagram
[ top ]
Element RestrictionList
Diagram
Diagram Attribute.tmp#RestrictionList_RestrictionCode
Instance
 
<RestrictionList>
  <RestrictionCode RestrictionType="">{0,unbounded}</RestrictionCode>
</RestrictionList>
[ top ]
Element RestrictionList / RestrictionCode
Diagram
Diagram Attribute.tmp#RestrictionList_RestrictionList_RestrictionCode_RestrictionType
Attributes
QName Type Use Annotation
RestrictionType xs:string required 
RestrictTo, Permit, or Deny
[ top ]
Element Address
Annotations
 
Generic Address Element
Diagram
Diagram Attribute.tmp#Address_Type Attribute.tmp#Address_Version Attribute.tmp#Address_Name Attribute.tmp#Address_Street1 Attribute.tmp#Address_Street2 Attribute.tmp#Address_Suburb Attribute.tmp#Address_City Attribute.tmp#Address_Area Attribute.tmp#Address_State Attribute.tmp#Address_Country Attribute.tmp#Address_Other Attribute.tmp#Address_PostCode Attribute.tmp#Address_GeoRef Attribute.tmp#Address_Phone Attribute.tmp#Address_Fax Attribute.tmp#Address_Email Attribute.tmp#Address_Social Attribute.tmp#Address_Notes Attribute.tmp#Address_TimeZone Attribute.tmp#Address_TimeZoneName
Instance
 
<Address Type="" Version="">
  <Name>{1,1}</Name>
  <Street1>{1,1}</Street1>
  <Street2>{1,1}</Street2>
  <Suburb>{0,1}</Suburb>
  <City>{1,1}</City>
  <Area>{0,1}</Area>
  <State>{0,1}</State>
  <Country>{0,1}</Country>
  <Other>{0,1}</Other>
  <PostCode>{1,1}</PostCode>
  <GeoRef>{0,1}</GeoRef>
  <Phone>{0,1}</Phone>
  <Fax>{0,1}</Fax>
  <Email>{0,1}</Email>
  <Social>{0,1}</Social>
  <Notes>{0,1}</Notes>
  <TimeZone>{0,1}</TimeZone>
  <TimeZoneName>{0,1}</TimeZoneName>
</Address>
Attributes
QName Type Use
Type restriction of xs:string optional
Version xs:decimal optional
[ top ]
Element Address / Name
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street1
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street2
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Suburb
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / City
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Area
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / State
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Country
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Other
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / PostCode
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / GeoRef
Diagram
Diagram Attribute.tmp#Address_Address_GeoRef_Lat Attribute.tmp#Address_Address_GeoRef_Long
Instance
 
<GeoRef>
  <Lat>{1,1}</Lat>
  <Long>{1,1}</Long>
</GeoRef>
[ top ]
Element Address / GeoRef / Lat
Diagram
Diagram
[ top ]
Element Address / GeoRef / Long
Diagram
Diagram
[ top ]
Element Address / Phone
Diagram
Diagram Attribute.tmp#Address_Address_Phone_Number
Instance
 
<Phone>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Phone>
[ top ]
Element Address / Phone / Number
Diagram
Diagram Attribute.tmp#Address_Address_Phone_Address_Address_Phone_Number_Type Attribute.tmp#Address_Address_Phone_Address_Address_Phone_Number_Seq Attribute.tmp#Address_Address_Phone_Address_Address_Phone_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Fax
Diagram
Diagram Attribute.tmp#Address_Address_Fax_Number
Instance
 
<Fax>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Fax>
[ top ]
Element Address / Fax / Number
Diagram
Diagram Attribute.tmp#Address_Address_Fax_Address_Address_Fax_Number_Type Attribute.tmp#Address_Address_Fax_Address_Address_Fax_Number_Seq Attribute.tmp#Address_Address_Fax_Address_Address_Fax_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Email
Diagram
Diagram Attribute.tmp#Address_Address_Email_Address
Instance
 
<Email>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Email>
[ top ]
Element Address / Email / Address
Diagram
Diagram Attribute.tmp#Address_Address_Email_Address_Address_Email_Address_Type Attribute.tmp#Address_Address_Email_Address_Address_Email_Address_Seq Attribute.tmp#Address_Address_Email_Address_Address_Email_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Social
Diagram
Diagram Attribute.tmp#Address_Address_Social_Address
Instance
 
<Social>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Social>
[ top ]
Element Address / Social / Address
Diagram
Diagram Attribute.tmp#Address_Address_Social_Address_Address_Social_Address_Type Attribute.tmp#Address_Address_Social_Address_Address_Social_Address_Seq Attribute.tmp#Address_Address_Social_Address_Address_Social_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Notes
Annotations
 
Address notes – may be used for special purposes such as delivery address notes
Diagram
Diagram
[ top ]
Element Address / TimeZone
Annotations
 
TimeZone Offset. Decimal 9.5 =  “+9:30”        http://wwp.greenwichmeantime.com/info/timezone.htm
Diagram
Diagram
[ top ]
Element Address / TimeZoneName
Annotations
 
Name of Time Zone (Microsoft)
Diagram
Diagram
[ top ]
Attribute Attribute / Value / @DataType
Used by
Element Attribute/Value
[ top ]
Attribute Attribute / @Deprecated
Used by
Element Attribute
[ top ]
Attribute Attribute / @Scope
Annotations
 
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
Used by
Element Attribute
[ top ]
Attribute Attributes / @Version
Used by
Element Attributes
[ top ]
Attribute CommonAttributes / @Culture
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Version
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadType
Annotations
 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadFilter
Annotations
 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @TransactionID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StartTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @EndTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @SiteID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StatusID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @ErrorCount
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Transformed
Used by
Attribute Group CommonAttributes
[ top ]
Attribute RestrictionList / RestrictionCode / @RestrictionType
Annotations
 
RestrictTo, Permit, or Deny
Used by
[ top ]
Attribute Address / Phone / Number / @Type
Facets
enumeration business
enumeration other
enumeration mobile
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Phone / Number / @Seq
Used by
[ top ]
Attribute Address / Phone / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Fax / Number / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Fax / Number / @Seq
Used by
[ top ]
Attribute Address / Fax / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Email / Address / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration personal
Used by
[ top ]
Attribute Address / Email / Address / @Seq
Used by
[ top ]
Attribute Address / Email / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / Social / Address / @Type
Facets
enumeration other
enumeration lynkedin
enumeration skype
enumeration im
enumeration twitter
enumeration facebook
enumeration website
Used by
[ top ]
Attribute Address / Social / Address / @Seq
Used by
[ top ]
Attribute Address / Social / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / @Type
Facets
enumeration business
enumeration other
enumeration physical
enumeration postal
enumeration delivery
enumeration home
enumeration work
Used by
Element Address
[ top ]
Attribute Address / @Version
Used by
Element Address
[ top ]
Attribute Group CommonAttributes
Diagram
Diagram Attribute.tmp#CommonAttributes_Culture Attribute.tmp#CommonAttributes_Version Attribute.tmp#CommonAttributes_LoadType Attribute.tmp#CommonAttributes_LoadFilter Attribute.tmp#CommonAttributes_TransactionID Attribute.tmp#CommonAttributes_StartTime Attribute.tmp#CommonAttributes_EndTime Attribute.tmp#CommonAttributes_SiteID Attribute.tmp#CommonAttributes_StatusID Attribute.tmp#CommonAttributes_ErrorCount Attribute.tmp#CommonAttributes_Transformed
Used by
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]
XML Schema documentation generated by ® XML Editor.