POST Api/AttendanceLog/GetStudentList

Request Information

URI Parameters

None.

Body Parameters

StudentListRequest
NameDescriptionTypeAdditional information
StaffID

string

None.

CLASSROOM

string

None.

CampusName

string

None.

UserID

string

None.

DeviceID

string

None.

DeviceOS

string

None.

Version

string

None.

accessToken

string

Required

Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$

Request Formats

application/json, text/json

Sample:
{
  "StaffID": "sample string 1",
  "CLASSROOM": "sample string 2",
  "CampusName": "sample string 3",
  "UserID": "sample string 4",
  "DeviceID": "sample string 5",
  "DeviceOS": "sample string 6",
  "Version": "sample string 7",
  "accessToken": "sample string 8"
}

text/html

Sample:
{"StaffID":"sample string 1","CLASSROOM":"sample string 2","CampusName":"sample string 3","UserID":"sample string 4","DeviceID":"sample string 5","DeviceOS":"sample string 6","Version":"sample string 7","accessToken":"sample string 8"}

application/xml, text/xml

Sample:
<StudentListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <CampusName>sample string 3</CampusName>
  <DeviceID>sample string 5</DeviceID>
  <DeviceOS>sample string 6</DeviceOS>
  <UserID>sample string 4</UserID>
  <Version>sample string 7</Version>
  <accessToken>sample string 8</accessToken>
  <CLASSROOM>sample string 2</CLASSROOM>
  <StaffID>sample string 1</StaffID>
</StudentListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StudentReturnResult
NameDescriptionTypeAdditional information
status

boolean

None.

message

string

None.

data

Collection of StudentListResponse

None.

totalCount

integer

None.

pageSize

integer

None.

currentPage

integer

None.

totalPages

integer

None.

previousPage

boolean

None.

nextPage

boolean

None.

accessToken

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "message": "sample string 2",
  "data": [
    {
      "Id": 1.0,
      "Name": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Class": "sample string 5"
    },
    {
      "Id": 1.0,
      "Name": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Class": "sample string 5"
    }
  ],
  "totalCount": 3,
  "pageSize": 4,
  "currentPage": 5,
  "totalPages": 6,
  "previousPage": true,
  "nextPage": true,
  "accessToken": "a4768b1a-b5c1-4561-86e7-324b8a368354"
}

text/html

Sample:
{"status":true,"message":"sample string 2","data":[{"Id":1.0,"Name":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Class":"sample string 5"},{"Id":1.0,"Name":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Class":"sample string 5"}],"totalCount":3,"pageSize":4,"currentPage":5,"totalPages":6,"previousPage":true,"nextPage":true,"accessToken":"a4768b1a-b5c1-4561-86e7-324b8a368354"}

application/xml, text/xml

Sample:
<StudentReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <currentPage>5</currentPage>
  <data>
    <StudentListResponse>
      <Class>sample string 5</Class>
      <FirstName>sample string 3</FirstName>
      <Id>1</Id>
      <LastName>sample string 4</LastName>
      <Name>sample string 2</Name>
    </StudentListResponse>
    <StudentListResponse>
      <Class>sample string 5</Class>
      <FirstName>sample string 3</FirstName>
      <Id>1</Id>
      <LastName>sample string 4</LastName>
      <Name>sample string 2</Name>
    </StudentListResponse>
  </data>
  <message>sample string 2</message>
  <nextPage>true</nextPage>
  <pageSize>4</pageSize>
  <previousPage>true</previousPage>
  <status>true</status>
  <totalCount>3</totalCount>
  <totalPages>6</totalPages>
</StudentReturnResult>