Specifying the INDEXNAME Parameter

Understanding the Web Services › The Data Returned by the Index List Web Service › Specifying the INDEXNAME Parameter

Specifying the INDEXNAME Parameter

The following table describes the vector entries identifying the index names for each cross-report index:

Entry	Description
Index Name Part 1	Part 1 of the index name
Index Name Part 2	Part 2 of the index name or "" if there is no part 2
Index Name Part 3	Part 3 of the index name or "" if there is no part 3
Index Name Part 4	Part 4 of the index name or "" if there is no part 4
Index Name Part 5	Part 5 of the index name or "" if there is no part 5
Index Name Part 6	Part 6 of the index name or "" if there is no part 6
Index Name Part 7	Part 7 of the index name or "" if there is no part 7
Index Name Part 8	Part 8 of the index name or "" if there is no part 8
Index Handle	Index handle to retrieve index values interim value – do not use to access an index

If the returnas value is "XMLString" or "XMLAttachment", entries for each matching entry are returned. The entry includes entries with the index names assigned to the specified report. Each entry is an <indexname> </indexname> pair. Entries for each part of the index name are in the pair. For each part, there is one entry and if there are any additional parts, they are present.

The following sample shows returned data:

<indexname>

<indexname1>INDEX1</indexname1>
<indexname2>INDEX2</indexname2>
<indexname3>INDEX3</indexname3>
<indexname4>INDEX4</indexname4>

</indexname>

Specifying INDEXVALUEs

If the returnas value is "Vector" or "StringArray", a vector entry for each matching entry is returned. The vector entry contains a string array with entries for returned information appropriate to the type of request. The string array has an entry for each portion of the report matching the index value for the index name specified. The entry includes the matching values, the report name, the report generation number, the report sequence number, and a report handle. You can use the report handle to access the portion of the report that matches the values that are specified in the entry.

The vector entries identifying the index names for each cross-report index are as follows:

Entry	Description
Index Value 1	Part 1 of the index value
Index Value 2	Part 2 of the index value or "" if there is no part 2
Index Value 3	Part 3 of the index value or "" if there is no part 3
Index Value 4	Part 4 of the index value or "" if there is no part 4
Index Value 5	Part 5 of the index value or "" if there is no part 5
Index Value 6	Part 6 of the index value or "" if there is no part 6
Index Value 7	Part 7 of the index value or "" if there is no part 7
Index Value 8	Part 8 of the index value or "" if there is no part 8
Report ID	Name of the report
Gen	Generation number
Seq	Sequence number
Report Handle	Report handle that can be used to retrieve the report

If the returnas value is "XMLString" or "XMLAttachment", entries for each matching entry are returned. Each entry represents a section of a report that is indexed by the cross-report index name. The entry is enclosed in <indexvalue > </ indexvalue > tags. Within the tags are entries for each matching value, the report name, the report generation number, the report sequence number, and a report handle. An entry resembles the following:

<indexvalue>

<indexvalue1>STATION000001</indexvalue1>
<indexvalue2>000003</indexvalue2>
<indexvalue3>0008</indexvalue3>
<indexvalue4>000000028</indexvalue4>
<reportname>L2-VI-A</reportname>
<generation>18</generation>
<sequence>3</sequence>

<reporthandle>d3f260e5c960c140404040404040404040404040ffedfffc0c0a000300000003000

00000</reporthandle>

  </indexvalue>