GET api/Dashboard?userid={userid}&token={token}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userid | string |
Default value is |
|
token | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
DashboardGetResponseName | Description | Type | Additional information |
---|---|---|---|
Data | Dashboard |
None. |
|
Response | BaseResponseItems |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "NumUnsignedOrders": 1, "AvgDaysOutstanding": 2, "NumDeclinedOrders": 3, "OutstandingByRequestor": [ { "Requestor": "sample string 1", "RequestorId": "sample string 2", "Count": 3 }, { "Requestor": "sample string 1", "RequestorId": "sample string 2", "Count": 3 } ], "DeclinesPerRequestor": [ { "Requestor": "sample string 1", "RequestorId": "sample string 2", "TotalCount": 3, "Reasons": [ { "Reason": "sample string 1", "Count": 2 }, { "Reason": "sample string 1", "Count": 2 } ] }, { "Requestor": "sample string 1", "RequestorId": "sample string 2", "TotalCount": 3, "Reasons": [ { "Reason": "sample string 1", "Count": 2 }, { "Reason": "sample string 1", "Count": 2 } ] } ] }, "Response": { "Processed": "sample string 1", "Error": "sample string 2" } }
application/xml, text/xml
Sample:
<DashboardGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Responses"> <Response> <Error>sample string 2</Error> <Processed>sample string 1</Processed> </Response> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignAPI.Models.DTOs"> <d2p1:AvgDaysOutstanding>2</d2p1:AvgDaysOutstanding> <d2p1:DeclinesPerRequestor> <d2p1:DeclinesPerRequestorItem> <d2p1:Reasons> <d2p1:DeclineReasonItem> <d2p1:Count>2</d2p1:Count> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:DeclineReasonItem> <d2p1:DeclineReasonItem> <d2p1:Count>2</d2p1:Count> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:DeclineReasonItem> </d2p1:Reasons> <d2p1:Requestor>sample string 1</d2p1:Requestor> <d2p1:RequestorId>sample string 2</d2p1:RequestorId> <d2p1:TotalCount>3</d2p1:TotalCount> </d2p1:DeclinesPerRequestorItem> <d2p1:DeclinesPerRequestorItem> <d2p1:Reasons> <d2p1:DeclineReasonItem> <d2p1:Count>2</d2p1:Count> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:DeclineReasonItem> <d2p1:DeclineReasonItem> <d2p1:Count>2</d2p1:Count> <d2p1:Reason>sample string 1</d2p1:Reason> </d2p1:DeclineReasonItem> </d2p1:Reasons> <d2p1:Requestor>sample string 1</d2p1:Requestor> <d2p1:RequestorId>sample string 2</d2p1:RequestorId> <d2p1:TotalCount>3</d2p1:TotalCount> </d2p1:DeclinesPerRequestorItem> </d2p1:DeclinesPerRequestor> <d2p1:NumDeclinedOrders>3</d2p1:NumDeclinedOrders> <d2p1:NumUnsignedOrders>1</d2p1:NumUnsignedOrders> <d2p1:OutstandingByRequestor> <d2p1:OutstandingByRequestorItem> <d2p1:Count>3</d2p1:Count> <d2p1:Requestor>sample string 1</d2p1:Requestor> <d2p1:RequestorId>sample string 2</d2p1:RequestorId> </d2p1:OutstandingByRequestorItem> <d2p1:OutstandingByRequestorItem> <d2p1:Count>3</d2p1:Count> <d2p1:Requestor>sample string 1</d2p1:Requestor> <d2p1:RequestorId>sample string 2</d2p1:RequestorId> </d2p1:OutstandingByRequestorItem> </d2p1:OutstandingByRequestor> </Data> </DashboardGetResponse>