GET api/v1/{posId}/kpisetups
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| posId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of KPISetup| Name | Description | Type | Additional information |
|---|---|---|---|
| StoreID | string |
None. |
|
| KPIID | integer |
None. |
|
| DisplayType | integer |
None. |
|
| TargetValue | decimal number |
None. |
|
| MarkValue1 | decimal number |
None. |
|
| MarkValue2 | decimal number |
None. |
|
| MarkValue3 | decimal number |
None. |
|
| SortOrder | integer |
None. |
|
| ShowOnLogin | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"StoreID": "sample string 1",
"KPIID": 2,
"DisplayType": 1,
"TargetValue": 1.0,
"MarkValue1": 1.0,
"MarkValue2": 1.0,
"MarkValue3": 1.0,
"SortOrder": 1,
"ShowOnLogin": true
},
{
"StoreID": "sample string 1",
"KPIID": 2,
"DisplayType": 1,
"TargetValue": 1.0,
"MarkValue1": 1.0,
"MarkValue2": 1.0,
"MarkValue3": 1.0,
"SortOrder": 1,
"ShowOnLogin": true
}
]
text/html
Sample:
[{"StoreID":"sample string 1","KPIID":2,"DisplayType":1,"TargetValue":1.0,"MarkValue1":1.0,"MarkValue2":1.0,"MarkValue3":1.0,"SortOrder":1,"ShowOnLogin":true},{"StoreID":"sample string 1","KPIID":2,"DisplayType":1,"TargetValue":1.0,"MarkValue1":1.0,"MarkValue2":1.0,"MarkValue3":1.0,"SortOrder":1,"ShowOnLogin":true}]
application/xml, text/xml
Sample:
<Root>
<Data>
<StoreID>sample string 1</StoreID>
<KPIID>2</KPIID>
<DisplayType>1</DisplayType>
<TargetValue>1</TargetValue>
<MarkValue1>1</MarkValue1>
<MarkValue2>1</MarkValue2>
<MarkValue3>1</MarkValue3>
<SortOrder>1</SortOrder>
<ShowOnLogin>true</ShowOnLogin>
</Data>
<Data>
<StoreID>sample string 1</StoreID>
<KPIID>2</KPIID>
<DisplayType>1</DisplayType>
<TargetValue>1</TargetValue>
<MarkValue1>1</MarkValue1>
<MarkValue2>1</MarkValue2>
<MarkValue3>1</MarkValue3>
<SortOrder>1</SortOrder>
<ShowOnLogin>true</ShowOnLogin>
</Data>
</Root>
application/csv
Sample:
Sample not available.
text/csv
Sample:
Sample not available.