POST Api/Dashboard/GetCandidateList

Request Information

URI Parameters

None.

Body Parameters

CandidateList
NameDescriptionTypeAdditional information
SessionId

integer

None.

ProgramLevel

integer

None.

Program

integer

None.

Gender

string

None.

Category

string

None.

State

string

None.

FromDate

date

None.

ToDate

date

None.

SearchTerm

string

None.

PageNumber

integer

None.

PageSize

integer

None.

TotalRecords

integer

None.

Candidates

Collection of CandidateListItem

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,
  "programLevel": 1,
  "program": 1,
  "gender": "sample string 1",
  "category": "sample string 2",
  "state": "sample string 3",
  "fromDate": "2026-08-11T17:27:03.4502702+05:30",
  "toDate": "2026-08-11T17:27:03.4502702+05:30",
  "searchTerm": "sample string 4",
  "pageNumber": 5,
  "pageSize": 6,
  "totalRecords": 7,
  "candidates": [
    {
      "id": 1,
      "applicationID": "sample string 2",
      "fullName": "sample string 3",
      "email": "sample string 4",
      "mobileNo": "sample string 5",
      "gender": "sample string 6",
      "category": "sample string 7",
      "state": "sample string 8",
      "program": "sample string 9",
      "createdDate": "2026-08-11T17:27:03.4512701+05:30",
      "examStatus": "sample string 10",
      "status": true
    },
    {
      "id": 1,
      "applicationID": "sample string 2",
      "fullName": "sample string 3",
      "email": "sample string 4",
      "mobileNo": "sample string 5",
      "gender": "sample string 6",
      "category": "sample string 7",
      "state": "sample string 8",
      "program": "sample string 9",
      "createdDate": "2026-08-11T17:27:03.4512701+05:30",
      "examStatus": "sample string 10",
      "status": true
    }
  ],
  "opCode": 8,
  "isException": true,
  "exceptionMessage": "sample string 10",
  "ds": null,
  "id": "sample string 11",
  "strId": "sample string 12",
  "userId": 13,
  "status": 14,
  "message": "sample string 15",
  "pageIndex": "sample string 17",
  "responseValue": {}
}

application/xml, text/xml

Sample:
<CandidateList 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 17</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 16</PageSize>
  <exceptionMessage xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 10</exceptionMessage>
  <id xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 11</id>
  <isException xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">true</isException>
  <message xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 15</message>
  <opCode xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">8</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">14</status>
  <strId xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">sample string 12</strId>
  <userId xmlns="http://schemas.datacontract.org/2004/07/DLLUtility">13</userId>
  <Candidates>
    <CandidateListItem>
      <ApplicationID>sample string 2</ApplicationID>
      <Category>sample string 7</Category>
      <CreatedDate>2026-08-11T17:27:03.4512701+05:30</CreatedDate>
      <Email>sample string 4</Email>
      <ExamStatus>sample string 10</ExamStatus>
      <FullName>sample string 3</FullName>
      <Gender>sample string 6</Gender>
      <ID>1</ID>
      <MobileNo>sample string 5</MobileNo>
      <Program>sample string 9</Program>
      <State>sample string 8</State>
      <Status>true</Status>
    </CandidateListItem>
    <CandidateListItem>
      <ApplicationID>sample string 2</ApplicationID>
      <Category>sample string 7</Category>
      <CreatedDate>2026-08-11T17:27:03.4512701+05:30</CreatedDate>
      <Email>sample string 4</Email>
      <ExamStatus>sample string 10</ExamStatus>
      <FullName>sample string 3</FullName>
      <Gender>sample string 6</Gender>
      <ID>1</ID>
      <MobileNo>sample string 5</MobileNo>
      <Program>sample string 9</Program>
      <State>sample string 8</State>
      <Status>true</Status>
    </CandidateListItem>
  </Candidates>
  <Category>sample string 2</Category>
  <FromDate>2026-08-11T17:27:03.4502702+05:30</FromDate>
  <Gender>sample string 1</Gender>
  <PageNumber>5</PageNumber>
  <PageSize>6</PageSize>
  <Program>1</Program>
  <ProgramLevel>1</ProgramLevel>
  <SearchTerm>sample string 4</SearchTerm>
  <SessionId>1</SessionId>
  <State>sample string 3</State>
  <ToDate>2026-08-11T17:27:03.4502702+05:30</ToDate>
  <TotalRecords>7</TotalRecords>
</CandidateList>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CandidateList'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.