GET api/Student/GetStudents?franchiseeId={franchiseeId}

Gets list of franchisees students

Request Information

URI Parameters

Name	Description	Type	Additional information
franchiseeId	Franchisee Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

IEnumerable(Of BO.Models.Students.StudentBasic)

Collection of BO.Models.Students.StudentBasic

Name	Type	Additional information
StudentId	integer	None.
FirstName	string	Required
LastName	string	Required
Suburb	string	Required
StateId	integer	Required
Postcode	string	Required
Address	string	Required
PhoneNumber	string	None.
MobileNumber	string	None.
Birthday	date	Required
Female	boolean	Required
Email	string	Required
EmergencyName	string	Required
EmergencyPhoneNumber	string	Required
Comment	string	None.
Newsletter	boolean	None.
FranchiseeId	integer	Required
StudentMarketings	Collection of BO.Models.Students.StudentMarketing	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "2",
    "StudentId": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Suburb": "sample string 4",
    "StateId": 5,
    "Postcode": "sample string 6",
    "Address": "sample string 7",
    "PhoneNumber": "sample string 8",
    "MobileNumber": "sample string 9",
    "Birthday": "2024-11-07T09:27:51.2918881+08:00",
    "Female": true,
    "Email": "sample string 11",
    "EmergencyName": "sample string 12",
    "EmergencyPhoneNumber": "sample string 13",
    "Comment": "sample string 14",
    "Newsletter": true,
    "FranchiseeId": 16,
    "StudentMarketings": {
      "$id": "3",
      "$values": [
        {
          "$id": "4"
        },
        {
          "$ref": "4"
        }
      ]
    }
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStudentBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Students">
  <StudentBasic>
    <Address>sample string 7</Address>
    <Birthday>2024-11-07T09:27:51.2918881+08:00</Birthday>
    <Comment>sample string 14</Comment>
    <Email>sample string 11</Email>
    <EmergencyName>sample string 12</EmergencyName>
    <EmergencyPhoneNumber>sample string 13</EmergencyPhoneNumber>
    <Female>true</Female>
    <FirstName>sample string 2</FirstName>
    <FranchiseeId>16</FranchiseeId>
    <LastName>sample string 3</LastName>
    <MobileNumber>sample string 9</MobileNumber>
    <Newsletter>true</Newsletter>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Postcode>sample string 6</Postcode>
    <StateId>5</StateId>
    <StudentId>1</StudentId>
    <StudentMarketings>
      <StudentMarketing />
      <StudentMarketing />
    </StudentMarketings>
    <Suburb>sample string 4</Suburb>
  </StudentBasic>
  <StudentBasic>
    <Address>sample string 7</Address>
    <Birthday>2024-11-07T09:27:51.2918881+08:00</Birthday>
    <Comment>sample string 14</Comment>
    <Email>sample string 11</Email>
    <EmergencyName>sample string 12</EmergencyName>
    <EmergencyPhoneNumber>sample string 13</EmergencyPhoneNumber>
    <Female>true</Female>
    <FirstName>sample string 2</FirstName>
    <FranchiseeId>16</FranchiseeId>
    <LastName>sample string 3</LastName>
    <MobileNumber>sample string 9</MobileNumber>
    <Newsletter>true</Newsletter>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Postcode>sample string 6</Postcode>
    <StateId>5</StateId>
    <StudentId>1</StudentId>
    <StudentMarketings>
      <StudentMarketing />
      <StudentMarketing />
    </StudentMarketings>
    <Suburb>sample string 4</Suburb>
  </StudentBasic>
</ArrayOfStudentBasic>