GET api/Values/PortalDashboard?strDistributorId={strDistributorId}&strCompanyId={strCompanyId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| strDistributorId | string |
Required |
|
| strCompanyId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
returndbmlDashboard| Name | Description | Type | Additional information |
|---|---|---|---|
| objdbmlDashboard | dbmlDashboard |
None. |
|
| objdbmlDashboardGraph | Collection of dbmlDashboardGraph |
None. |
|
| objdbmlStatus | dbmlStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"objdbmlDashboard": {
"CompanyCnt": 1,
"OrderCnt": 2,
"DistributorCnt": 3,
"EmployeeCnt": 4
},
"objdbmlDashboardGraph": [
{
"OrderYear": 1,
"OrderMonth": "sample string 2",
"OrderCnt": 3,
"OrderAmt": 4.0
},
{
"OrderYear": 1,
"OrderMonth": "sample string 2",
"OrderCnt": 3,
"OrderAmt": 4.0
}
],
"objdbmlStatus": {
"StatusId": 1,
"Status": "sample string 2",
"PKId": 3,
"Remark": "sample string 4"
}
}
text/html
Sample:
{"objdbmlDashboard":{"CompanyCnt":1,"OrderCnt":2,"DistributorCnt":3,"EmployeeCnt":4},"objdbmlDashboardGraph":[{"OrderYear":1,"OrderMonth":"sample string 2","OrderCnt":3,"OrderAmt":4.0},{"OrderYear":1,"OrderMonth":"sample string 2","OrderCnt":3,"OrderAmt":4.0}],"objdbmlStatus":{"StatusId":1,"Status":"sample string 2","PKId":3,"Remark":"sample string 4"}}
application/xml, text/xml
Sample:
<returndbmlDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TimkenOrderService.Models">
<objdbmlDashboard xmlns:d2p1="http://schemas.datacontract.org/2004/07/TimkenOrderService.TimkenSchema">
<d2p1:CompanyCnt>1</d2p1:CompanyCnt>
<d2p1:DistributorCnt>3</d2p1:DistributorCnt>
<d2p1:EmployeeCnt>4</d2p1:EmployeeCnt>
<d2p1:OrderCnt>2</d2p1:OrderCnt>
</objdbmlDashboard>
<objdbmlDashboardGraph xmlns:d2p1="http://schemas.datacontract.org/2004/07/TimkenOrderService.TimkenSchema">
<d2p1:dbmlDashboardGraph>
<d2p1:OrderAmt>4</d2p1:OrderAmt>
<d2p1:OrderCnt>3</d2p1:OrderCnt>
<d2p1:OrderMonth>sample string 2</d2p1:OrderMonth>
<d2p1:OrderYear>1</d2p1:OrderYear>
</d2p1:dbmlDashboardGraph>
<d2p1:dbmlDashboardGraph>
<d2p1:OrderAmt>4</d2p1:OrderAmt>
<d2p1:OrderCnt>3</d2p1:OrderCnt>
<d2p1:OrderMonth>sample string 2</d2p1:OrderMonth>
<d2p1:OrderYear>1</d2p1:OrderYear>
</d2p1:dbmlDashboardGraph>
</objdbmlDashboardGraph>
<objdbmlStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TimkenOrderService.TimkenSchema">
<d2p1:PKId>3</d2p1:PKId>
<d2p1:Remark>sample string 4</d2p1:Remark>
<d2p1:Status>sample string 2</d2p1:Status>
<d2p1:StatusId>1</d2p1:StatusId>
</objdbmlStatus>
</returndbmlDashboard>