SWAPI – KpiFilterValuesQuery

Use this command to obtain valid filter values for a SuccessWare®21 Kpi/GroupByName, between two dates.

Request

<?xml version="1.0" encoding="UTF-8"?>

<SessionRequest Version="string" SessionID="{3E6C8178-9AAE-4B8F-9ABD-6084FC7B78DB}" RequestID="string">

<KpiFilterValuesQuery Version="string">

<KpiID>int</KpiID>

<StartDate>date</StartDate>

<EndDate>date</EndDate>

<GroupByName>string</GroupByName>

<IncludeRefBookValues>boolean</IncludeRefBookValues>

</KpiFilterValuesQuery>

</SessionRequest>

· KpiID – The Kpi ID to get values for

o Can be obtained from the KpiListQuery SWAPI command

· StartDate – The beginning date

· EndDate – The ending date

· GroupByName – The GroupByName you want to get values for

o Can be obtained from the KpiGroupByQuery SWAPI command.

· IncludeRefBookValues – If TRUE, then in addition to all distinct values in the actual data, also include all appropriate active reference book values (whether they are in the data or not).

Response

<?xml version="1.0" encoding="UTF-8"?>

<KpiFilterValuesQueryResponse>

<KpiFilterValuesQueryDataset>

<KpiFilterValuesQueryRecord>

<FilterValue>string</FilterValue>

</KpiFilterValuesQueryRecord>

</KpiFilterValuesQueryDataset>

</KpiFilterValuesQueryResponse>

· FilterValue – A valid filter value

Examples

IncludeRefBookValues Equals False

<?xml version="1.0" encoding="UTF-8"?>

<SessionRequest Version="string" SessionID="{3E6C8178-9AAE-4B8F-9ABD-6084FC7B78DB}" RequestID="string">

<KpiFilterValuesQuery Version="string">

<KpiID>1</KpiID>

<StartDate>2015-01-01</StartDate>

<EndDate>2015-12-31</EndDate>

<GroupByName>Primary Technician (Code)</GroupByName>

<IncludeRefBookValues>0</IncludeRefBookValues>

</KpiFilterValuesQuery>

</SessionRequest>

<?xml version="1.0" encoding="UTF-8"?>

<KpiFilterValuesQueryResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.900.1" RequestID="string">

<KpiFilterValuesQueryDataset>

<KpiFilterValuesQueryRecord>

<FilterValue>CARREI</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>JEADAE</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>LEAKLO</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>ROBLEV</FilterValue>

</KpiFilterValuesQueryRecord>

</KpiFilterValuesQueryDataset>

</KpiFilterValuesQueryResponse>

IncludeRefBookValues Equals True

<?xml version="1.0" encoding="UTF-8"?>

<SessionRequest Version="string" SessionID="{3E6C8178-9AAE-4B8F-9ABD-6084FC7B78DB}" RequestID="string">

<KpiFilterValuesQuery Version="string">

<KpiID>1</KpiID>

<StartDate>2015-01-01</StartDate>

<EndDate>2015-12-31</EndDate>

<GroupByName>Primary Technician (Code)</GroupByName>

<IncludeRefBookValues>1</IncludeRefBookValues>

</KpiFilterValuesQuery>

</SessionRequest>

<?xml version="1.0" encoding="UTF-8"?>

<KpiFilterValuesQueryResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.900.1" RequestID="string">

<KpiFilterValuesQueryDataset>

<KpiFilterValuesQueryRecord>

<FilterValue>ADEMUI</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>ALFTSU</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>CARREI</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>JACODU</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>JEADAE</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>LEAKLO</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>LEAWIN</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>ROBLEV</FilterValue>

</KpiFilterValuesQueryRecord>

<KpiFilterValuesQueryRecord>

<FilterValue>ZACPAT</FilterValue>

</KpiFilterValuesQueryRecord>

</KpiFilterValuesQueryDataset>

</KpiFilterValuesQueryResponse>