PayloadStructureType

PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PayloadStructureType" abstract="true">
  <xs:annotation>
   <xs:documentation>PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).</xs:documentation>
  </xs:annotation>
  <xs:sequence>
   <xs:choice>
    <xs:element name="ProvisionAgreement" type="ProvisionAgreementReferenceType">
     <xs:annotation>
      <xs:documentation>ProvisionAgreement references a provision agreement which the data or metadata is reported against.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="StructureUsage" type="StructureUsageReferenceType">
     <xs:annotation>
      <xs:documentation>StructureUsage references a flow which the data or metadata is reported against.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="Structure" type="StructureReferenceType">
     <xs:annotation>
      <xs:documentation>Structure references the structure which defines the structure of the data or metadata set.</xs:documentation>
     </xs:annotation>
    </xs:element>
   </xs:choice>
  </xs:sequence>
  <xs:attribute name="structureID" type="xs:ID" use="required">
   <xs:annotation>
    <xs:documentation>The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
  <xs:attribute name="schemaURL" type="xs:anyURI" use="optional">
   <xs:annotation>
    <xs:documentation>The schemaURL attribute provides a location from which the structure specific schema can be located.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
  <xs:attribute name="namespace" type="xs:anyURI" use="optional">
   <xs:annotation>
    <xs:documentation>The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
  <xs:attribute name="dimensionAtObservation" type="ObservationDimensionType" use="optional">
   <xs:annotation>
    <xs:documentation>The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
  <xs:attribute name="explicitMeasures" type="xs:boolean" use="optional">
   <xs:annotation>
    <xs:documentation>The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
  <xs:attributeGroup ref="ExternalReferenceAttributeGroup" />
 </xs:complexType>