POST Api/Dashboard/GetSummary
Request Information
URI Parameters
None.
Body Parameters
DashboardSummary| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionId | integer |
None. |
|
| ExamId | integer |
None. |
|
| TotalCandidates | integer |
None. |
|
| TodayRegistrations | integer |
None. |
|
| WeeklyRegistrations | integer |
None. |
|
| MonthlyRegistrations | integer |
None. |
|
| TotalExams | integer |
None. |
|
| OngoingExams | integer |
None. |
|
| CompletedAttempts | integer |
None. |
|
| TotalQuestions | integer |
None. |
|
| TotalSubjects | integer |
None. |
|
| TodayExamAttempts | integer |
None. |
|
| ActiveExamsNow | integer |
None. |
|
| TotalMeritStudents | integer |
None. |
|
| BlockedCandidates | integer |
None. |
|
| TotalViolations | integer |
None. |
|
| opCode | integer |
None. |
|
| isException | boolean |
None. |
|
| exceptionMessage | string |
None. |
|
| DS | DataSet |
None. |
|
| id | string |
None. |
|
| strId | string |
None. |
|
| userId | integer |
None. |
|
| status | integer |
None. |
|
| message | string |
None. |
|
| PageSize | string |
None. |
|
| PageIndex | string |
None. |
|
| responseValue | DataSet |
None. |
Request Formats
application/json, text/json
Sample:
{
"sessionId": 1,
"examId": 1,
"totalCandidates": 1,
"todayRegistrations": 2,
"weeklyRegistrations": 3,
"monthlyRegistrations": 4,
"totalExams": 5,
"ongoingExams": 6,
"completedAttempts": 7,
"totalQuestions": 8,
"totalSubjects": 9,
"todayExamAttempts": 10,
"activeExamsNow": 11,
"totalMeritStudents": 12,
"blockedCandidates": 13,
"totalViolations": 14,
"opCode": 15,
"isException": true,
"exceptionMessage": "sample string 17",
"ds": null,
"id": "sample string 18",
"strId": "sample string 19",
"userId": 20,
"status": 21,
"message": "sample string 22",
"pageSize": "sample string 23",
"pageIndex": "sample string 24",
"responseValue": {}
}
application/xml, text/xml
Sample:
<DashboardSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSWebAPI.Models">
<DS i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/DLLUtility" />
<PageIndex xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 24</PageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 23</PageSize>
<exceptionMessage xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 17</exceptionMessage>
<id xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 18</id>
<isException xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">true</isException>
<message xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 22</message>
<opCode xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">15</opCode>
<responseValue xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">
<xs:schema id="sample_x0020_string_x0020_3" targetNamespace="sample string 4" xmlns:mstns="sample string 4" xmlns="sample string 4" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:element name="sample_x0020_string_x0020_3" msdata:IsDataSet="true" msdata:CaseSensitive="true" msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded" />
</xs:complexType>
</xs:element>
</xs:schema>
<diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</responseValue>
<status xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">21</status>
<strId xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 19</strId>
<userId xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">20</userId>
<ActiveExamsNow>11</ActiveExamsNow>
<BlockedCandidates>13</BlockedCandidates>
<CompletedAttempts>7</CompletedAttempts>
<ExamId>1</ExamId>
<MonthlyRegistrations>4</MonthlyRegistrations>
<OngoingExams>6</OngoingExams>
<SessionId>1</SessionId>
<TodayExamAttempts>10</TodayExamAttempts>
<TodayRegistrations>2</TodayRegistrations>
<TotalCandidates>1</TotalCandidates>
<TotalExams>5</TotalExams>
<TotalMeritStudents>12</TotalMeritStudents>
<TotalQuestions>8</TotalQuestions>
<TotalSubjects>9</TotalSubjects>
<TotalViolations>14</TotalViolations>
<WeeklyRegistrations>3</WeeklyRegistrations>
</DashboardSummary>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |