Dimension GetAttributeColumns

Retrieves the specified attribute columns of the given dimension.

An attribute column contains the ID of each dimension element along with the corresponding value from the specified attribute field in the designated attribute table.

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="129" Class="Dimension" Method="GetAttributeColumns">
    <Alea:Attributes Dimension="CURR">
      <Alea:Column Caption="true" />
      <Alea:Column AttribTableID="1" FieldName="OrderPos" />
      <Alea:Column AttribTableID="2" FieldName="French" />
    </Alea:Attributes>
  </Alea:Request>
</Alea:Document>

Answer

<Alea:Document>
  <Alea:Request RequestID="129">
    <Alea:Return>
      <Alea:Attributes Dimension="CURR">
        <Alea:Column Caption="true">
          <Alea:Attribute AttribValue="CHF" ElemId="1" />
          <Alea:Attribute AttribValue="EUR" ElemId="3" />
          <Alea:Attribute AttribValue="GBP" ElemId="4" />
          <Alea:Attribute AttribValue="HKD" ElemId="5" />
          [...]
        </Alea:Column>
        <Alea:Column AttribTableID="1" FieldName="OrderPos">
          <Alea:Attribute AttribValue="0" ElemId="1" />
          <Alea:Attribute AttribValue="0" ElemId="2" />
          <Alea:Attribute AttribValue="0" ElemId="3" />
          <Alea:Attribute AttribValue="0" ElemId="4" />
          <Alea:Attribute AttribValue="0" ElemId="5" />
          [...]
        </Alea:Column>
        <Alea:Column AttribTableID="2" FieldName="French">
          <Alea:Attribute AttribValue="CHF" ElemId="1" />
          <Alea:Attribute AttribValue="EUR" ElemId="3" />
          <Alea:Attribute AttribValue="GBP" ElemId="4" />
          <Alea:Attribute AttribValue="HKD" ElemId="5" />
          [...]
        </Alea:Column>
      </Alea:Attributes>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

<Alea:Column Caption="true" /> is a shortcut for <Alea:Column AttribTableID="1" FieldName="Caption" />.

If Caption="true" is specified in the Alea:Column start-tag, it overrides the AttribTableID and FieldName XML attributes.

Caption can only be false when AttribTableID and FieldName exist and are valid. Otherwise, an error is returned.

If the value of a dimension attribute does not exist, then <Alea:Attribute> is not returned for this dimension element.

AttribTableID is 1-based.

Attribute values are returned without escaping, unlike Dimension Read.

Error

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="129">
    <Alea:Error ErrorID="error_code" />
  </Alea:Request>
</Alea:Document>
Related topics