SWAPI – KpiGroupByQuery

Use this command to obtain valid group by names for a SuccessWare®21 Kpi.

Request

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

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

<KpiGroupByQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

<KpiID>int</KpiID>

</KpiGroupByQuery>

</SessionRequest>

· KpiID – The Kpi ID to get valid group by names for

o Can be obtained from the KpiListQuery SWAPI command

Response

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

<KpiGroupByQueryResponse>

<KpiGroupByQueryData ReturnedRows="1">

<KpiGroupByQueryRecord>

<KpiID>int</KpiID>

<GroupByName>string</GroupByName>

</KpiGroupByQueryRecord>

</KpiGroupByQueryData>

</KpiGroupByQueryResponse>

· KpiID – The Kpi’s unique ID

· GroupByName – The group by name

Example

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

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

<KpiGroupByQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

<KpiID>4</KpiID>

</KpiGroupByQuery>

</SessionRequest>

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

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

<KpiGroupByQueryData ReturnedRows="8" FilteredRows="8" TotalRows="8" QueryOptions="KpiID=4">

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

<GroupByName>Dept Code (Job)</GroupByName>

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

<GroupByName>Dept Name (Job)</GroupByName>

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

<GroupByName>Job Class</GroupByName>

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

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

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

<GroupByName>Primary Technician (Fir Las)</GroupByName>

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

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

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

<GroupByName>Primary Technician (Las Fir)</GroupByName>

</KpiGroupByQueryRecord>

<KpiGroupByQueryRecord>

<KpiID>4</KpiID>

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

</KpiGroupByQueryRecord>

</KpiGroupByQueryData>

</KpiGroupByQueryResponse>