GET api/v1/students/filter/firstname/{firstName}?schoolCode={schoolCode}&studentNumber={studentNumber}&id={id}&lastName={lastName}&includeEnrollmentHistory={includeEnrollmentHistory}

Request Information

URI Parameters

Name	Type	Additional information
schoolCode	integer	None.
studentNumber	integer	None.
id	integer	None.
firstName	string	None.
lastName	string	None.
includeEnrollmentHistory	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of Student

Name	Type	Additional information
SchoolCode	integer	None.
StudentNumber	integer	None.
StudentId	integer	None.
FirstName	string	None.
LastName	string	None.
MiddleName	string	None.
Grade	integer	None.
NextGrade	integer	None.
Gender	string	None.
DateOfBirth	date	None.
Tag	string	None.
TagDescription	string	None.
ParentGuardian	string	None.
PrimaryPhone	string	None.
PhysicalAddress	Address	None.
MailingAddress	Address	None.
CorrespondenceLanguage	string	None.
HomeLanguage	string	None.
Comment3	string	None.
HealthIssues	string	None.
U1	string	None.
U2	string	None.
U3	string	None.
U4	string	None.
U5	string	None.
U6	string	None.
U7	string	None.
U8	string	None.
U9	string	None.
U10	string	None.
U11	string	None.
U12	string	None.
U13	string	None.
BCU	string	None.
BCY	string	None.
BST	string	None.
ETH	string	None.
PED	string	None.
RC1	string	None.
RC2	string	None.
RC3	string	None.
RC4	string	None.
RC5	string	None.
MW	string	None.
FW	string	None.
PEM	string	None.
NS	integer	None.
RS	integer	None.
NRS	integer	None.
LF	string	None.
Contacts	Collection of Contact	None.
EnrollmentHistory	Collection of Enrollment	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SchoolCode": 1,
    "StudentNumber": 2,
    "StudentId": 3,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleName": "sample string 6",
    "Grade": 7,
    "NextGrade": 8,
    "Gender": "sample string 9",
    "DateOfBirth": "2024-06-29T00:38:51.8362401-07:00",
    "Tag": "sample string 11",
    "TagDescription": "sample string 12",
    "ParentGuardian": "sample string 13",
    "PrimaryPhone": "sample string 14",
    "PhysicalAddress": {
      "Street1": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Zip": "sample string 4"
    },
    "MailingAddress": {
      "Street1": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Zip": "sample string 4"
    },
    "CorrespondenceLanguage": "sample string 15",
    "HomeLanguage": "sample string 16",
    "Comment3": "sample string 17",
    "HealthIssues": "sample string 18",
    "U1": "sample string 19",
    "U2": "sample string 20",
    "U3": "sample string 21",
    "U4": "sample string 22",
    "U5": "sample string 23",
    "U6": "sample string 24",
    "U7": "sample string 25",
    "U8": "sample string 26",
    "U9": "sample string 27",
    "U10": "sample string 28",
    "U11": "sample string 29",
    "U12": "sample string 30",
    "U13": "sample string 31",
    "BCU": "sample string 32",
    "BCY": "sample string 33",
    "BST": "sample string 34",
    "ETH": "sample string 35",
    "PED": "sample string 36",
    "RC1": "sample string 37",
    "RC2": "sample string 38",
    "RC3": "sample string 39",
    "RC4": "sample string 40",
    "RC5": "sample string 41",
    "MW": "sample string 42",
    "FW": "sample string 43",
    "PEM": "sample string 44",
    "NS": 45,
    "RS": 46,
    "NRS": 47,
    "LF": "sample string 48",
    "Contacts": [
      {
        "SchoolCode": 1,
        "StudentNumber": 2,
        "StudentId": 3,
        "SequenceNumber": 4,
        "OrderNumber": 5,
        "ContactName": "sample string 6",
        "FirstName": "sample string 7",
        "MiddleName": "sample string 8",
        "LastName": "sample string 9",
        "PhoneNumber": "sample string 10",
        "WorkPhone": "sample string 11",
        "CellPhone": "sample string 12",
        "Email": "sample string 13",
        "LivesWith": "sample string 14",
        "RelationCode": "sample string 15",
        "RelationDescription": "sample string 16",
        "Code": "sample string 17",
        "CodeDescription": "sample string 18",
        "MailTag": "sample string 19",
        "ENM": "sample string 20",
        "AP": "sample string 21",
        "ED": "2024-06-29T00:38:51.8362401-07:00",
        "CL": "sample string 22",
        "NP": "sample string 23",
        "AN": "sample string 24",
        "ELC": "sample string 25",
        "Address": {
          "Street1": "sample string 1",
          "City": "sample string 2",
          "State": "sample string 3",
          "Zip": "sample string 4"
        }
      },
      {
        "SchoolCode": 1,
        "StudentNumber": 2,
        "StudentId": 3,
        "SequenceNumber": 4,
        "OrderNumber": 5,
        "ContactName": "sample string 6",
        "FirstName": "sample string 7",
        "MiddleName": "sample string 8",
        "LastName": "sample string 9",
        "PhoneNumber": "sample string 10",
        "WorkPhone": "sample string 11",
        "CellPhone": "sample string 12",
        "Email": "sample string 13",
        "LivesWith": "sample string 14",
        "RelationCode": "sample string 15",
        "RelationDescription": "sample string 16",
        "Code": "sample string 17",
        "CodeDescription": "sample string 18",
        "MailTag": "sample string 19",
        "ENM": "sample string 20",
        "AP": "sample string 21",
        "ED": "2024-06-29T00:38:51.8362401-07:00",
        "CL": "sample string 22",
        "NP": "sample string 23",
        "AN": "sample string 24",
        "ELC": "sample string 25",
        "Address": {
          "Street1": "sample string 1",
          "City": "sample string 2",
          "State": "sample string 3",
          "Zip": "sample string 4"
        }
      }
    ],
    "EnrollmentHistory": [
      {
        "StudentId": 1,
        "SchoolCode": 2,
        "StudentNumber": 3,
        "Year": 4,
        "Grade": 5,
        "EnterDate": "2024-06-29T00:38:51.8362401-07:00",
        "LeaveDate": "2024-06-29T00:38:51.8362401-07:00"
      },
      {
        "StudentId": 1,
        "SchoolCode": 2,
        "StudentNumber": 3,
        "Year": 4,
        "Grade": 5,
        "EnterDate": "2024-06-29T00:38:51.8362401-07:00",
        "LeaveDate": "2024-06-29T00:38:51.8362401-07:00"
      }
    ]
  },
  {
    "SchoolCode": 1,
    "StudentNumber": 2,
    "StudentId": 3,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleName": "sample string 6",
    "Grade": 7,
    "NextGrade": 8,
    "Gender": "sample string 9",
    "DateOfBirth": "2024-06-29T00:38:51.8362401-07:00",
    "Tag": "sample string 11",
    "TagDescription": "sample string 12",
    "ParentGuardian": "sample string 13",
    "PrimaryPhone": "sample string 14",
    "PhysicalAddress": {
      "Street1": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Zip": "sample string 4"
    },
    "MailingAddress": {
      "Street1": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Zip": "sample string 4"
    },
    "CorrespondenceLanguage": "sample string 15",
    "HomeLanguage": "sample string 16",
    "Comment3": "sample string 17",
    "HealthIssues": "sample string 18",
    "U1": "sample string 19",
    "U2": "sample string 20",
    "U3": "sample string 21",
    "U4": "sample string 22",
    "U5": "sample string 23",
    "U6": "sample string 24",
    "U7": "sample string 25",
    "U8": "sample string 26",
    "U9": "sample string 27",
    "U10": "sample string 28",
    "U11": "sample string 29",
    "U12": "sample string 30",
    "U13": "sample string 31",
    "BCU": "sample string 32",
    "BCY": "sample string 33",
    "BST": "sample string 34",
    "ETH": "sample string 35",
    "PED": "sample string 36",
    "RC1": "sample string 37",
    "RC2": "sample string 38",
    "RC3": "sample string 39",
    "RC4": "sample string 40",
    "RC5": "sample string 41",
    "MW": "sample string 42",
    "FW": "sample string 43",
    "PEM": "sample string 44",
    "NS": 45,
    "RS": 46,
    "NRS": 47,
    "LF": "sample string 48",
    "Contacts": [
      {
        "SchoolCode": 1,
        "StudentNumber": 2,
        "StudentId": 3,
        "SequenceNumber": 4,
        "OrderNumber": 5,
        "ContactName": "sample string 6",
        "FirstName": "sample string 7",
        "MiddleName": "sample string 8",
        "LastName": "sample string 9",
        "PhoneNumber": "sample string 10",
        "WorkPhone": "sample string 11",
        "CellPhone": "sample string 12",
        "Email": "sample string 13",
        "LivesWith": "sample string 14",
        "RelationCode": "sample string 15",
        "RelationDescription": "sample string 16",
        "Code": "sample string 17",
        "CodeDescription": "sample string 18",
        "MailTag": "sample string 19",
        "ENM": "sample string 20",
        "AP": "sample string 21",
        "ED": "2024-06-29T00:38:51.8362401-07:00",
        "CL": "sample string 22",
        "NP": "sample string 23",
        "AN": "sample string 24",
        "ELC": "sample string 25",
        "Address": {
          "Street1": "sample string 1",
          "City": "sample string 2",
          "State": "sample string 3",
          "Zip": "sample string 4"
        }
      },
      {
        "SchoolCode": 1,
        "StudentNumber": 2,
        "StudentId": 3,
        "SequenceNumber": 4,
        "OrderNumber": 5,
        "ContactName": "sample string 6",
        "FirstName": "sample string 7",
        "MiddleName": "sample string 8",
        "LastName": "sample string 9",
        "PhoneNumber": "sample string 10",
        "WorkPhone": "sample string 11",
        "CellPhone": "sample string 12",
        "Email": "sample string 13",
        "LivesWith": "sample string 14",
        "RelationCode": "sample string 15",
        "RelationDescription": "sample string 16",
        "Code": "sample string 17",
        "CodeDescription": "sample string 18",
        "MailTag": "sample string 19",
        "ENM": "sample string 20",
        "AP": "sample string 21",
        "ED": "2024-06-29T00:38:51.8362401-07:00",
        "CL": "sample string 22",
        "NP": "sample string 23",
        "AN": "sample string 24",
        "ELC": "sample string 25",
        "Address": {
          "Street1": "sample string 1",
          "City": "sample string 2",
          "State": "sample string 3",
          "Zip": "sample string 4"
        }
      }
    ],
    "EnrollmentHistory": [
      {
        "StudentId": 1,
        "SchoolCode": 2,
        "StudentNumber": 3,
        "Year": 4,
        "Grade": 5,
        "EnterDate": "2024-06-29T00:38:51.8362401-07:00",
        "LeaveDate": "2024-06-29T00:38:51.8362401-07:00"
      },
      {
        "StudentId": 1,
        "SchoolCode": 2,
        "StudentNumber": 3,
        "Year": 4,
        "Grade": 5,
        "EnterDate": "2024-06-29T00:38:51.8362401-07:00",
        "LeaveDate": "2024-06-29T00:38:51.8362401-07:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfStudent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SchoolMint.Aeries.Data">
  <Student>
    <BCU>sample string 32</BCU>
    <BCY>sample string 33</BCY>
    <BST>sample string 34</BST>
    <Comment3>sample string 17</Comment3>
    <Contacts>
      <Contact>
        <AN>sample string 24</AN>
        <AP>sample string 21</AP>
        <Address>
          <City>sample string 2</City>
          <State>sample string 3</State>
          <Street1>sample string 1</Street1>
          <Zip>sample string 4</Zip>
        </Address>
        <CL>sample string 22</CL>
        <CellPhone>sample string 12</CellPhone>
        <Code>sample string 17</Code>
        <CodeDescription>sample string 18</CodeDescription>
        <ContactName>sample string 6</ContactName>
        <ED>2024-06-29T00:38:51.8362401-07:00</ED>
        <ELC>sample string 25</ELC>
        <ENM>sample string 20</ENM>
        <Email>sample string 13</Email>
        <FirstName>sample string 7</FirstName>
        <LastName>sample string 9</LastName>
        <LivesWith>sample string 14</LivesWith>
        <MailTag>sample string 19</MailTag>
        <MiddleName>sample string 8</MiddleName>
        <NP>sample string 23</NP>
        <OrderNumber>5</OrderNumber>
        <PhoneNumber>sample string 10</PhoneNumber>
        <RelationCode>sample string 15</RelationCode>
        <RelationDescription>sample string 16</RelationDescription>
        <SchoolCode>1</SchoolCode>
        <SequenceNumber>4</SequenceNumber>
        <StudentId>3</StudentId>
        <StudentNumber>2</StudentNumber>
        <WorkPhone>sample string 11</WorkPhone>
      </Contact>
      <Contact>
        <AN>sample string 24</AN>
        <AP>sample string 21</AP>
        <Address>
          <City>sample string 2</City>
          <State>sample string 3</State>
          <Street1>sample string 1</Street1>
          <Zip>sample string 4</Zip>
        </Address>
        <CL>sample string 22</CL>
        <CellPhone>sample string 12</CellPhone>
        <Code>sample string 17</Code>
        <CodeDescription>sample string 18</CodeDescription>
        <ContactName>sample string 6</ContactName>
        <ED>2024-06-29T00:38:51.8362401-07:00</ED>
        <ELC>sample string 25</ELC>
        <ENM>sample string 20</ENM>
        <Email>sample string 13</Email>
        <FirstName>sample string 7</FirstName>
        <LastName>sample string 9</LastName>
        <LivesWith>sample string 14</LivesWith>
        <MailTag>sample string 19</MailTag>
        <MiddleName>sample string 8</MiddleName>
        <NP>sample string 23</NP>
        <OrderNumber>5</OrderNumber>
        <PhoneNumber>sample string 10</PhoneNumber>
        <RelationCode>sample string 15</RelationCode>
        <RelationDescription>sample string 16</RelationDescription>
        <SchoolCode>1</SchoolCode>
        <SequenceNumber>4</SequenceNumber>
        <StudentId>3</StudentId>
        <StudentNumber>2</StudentNumber>
        <WorkPhone>sample string 11</WorkPhone>
      </Contact>
    </Contacts>
    <CorrespondenceLanguage>sample string 15</CorrespondenceLanguage>
    <DateOfBirth>2024-06-29T00:38:51.8362401-07:00</DateOfBirth>
    <ETH>sample string 35</ETH>
    <EnrollmentHistory>
      <Enrollment>
        <EnterDate>2024-06-29T00:38:51.8362401-07:00</EnterDate>
        <Grade>5</Grade>
        <LeaveDate>2024-06-29T00:38:51.8362401-07:00</LeaveDate>
        <SchoolCode>2</SchoolCode>
        <StudentId>1</StudentId>
        <StudentNumber>3</StudentNumber>
        <Year>4</Year>
      </Enrollment>
      <Enrollment>
        <EnterDate>2024-06-29T00:38:51.8362401-07:00</EnterDate>
        <Grade>5</Grade>
        <LeaveDate>2024-06-29T00:38:51.8362401-07:00</LeaveDate>
        <SchoolCode>2</SchoolCode>
        <StudentId>1</StudentId>
        <StudentNumber>3</StudentNumber>
        <Year>4</Year>
      </Enrollment>
    </EnrollmentHistory>
    <FW>sample string 43</FW>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 9</Gender>
    <Grade>7</Grade>
    <HealthIssues>sample string 18</HealthIssues>
    <HomeLanguage>sample string 16</HomeLanguage>
    <LF>sample string 48</LF>
    <LastName>sample string 5</LastName>
    <MW>sample string 42</MW>
    <MailingAddress>
      <City>sample string 2</City>
      <State>sample string 3</State>
      <Street1>sample string 1</Street1>
      <Zip>sample string 4</Zip>
    </MailingAddress>
    <MiddleName>sample string 6</MiddleName>
    <NRS>47</NRS>
    <NS>45</NS>
    <NextGrade>8</NextGrade>
    <PED>sample string 36</PED>
    <PEM>sample string 44</PEM>
    <ParentGuardian>sample string 13</ParentGuardian>
    <PhysicalAddress>
      <City>sample string 2</City>
      <State>sample string 3</State>
      <Street1>sample string 1</Street1>
      <Zip>sample string 4</Zip>
    </PhysicalAddress>
    <PrimaryPhone>sample string 14</PrimaryPhone>
    <RC1>sample string 37</RC1>
    <RC2>sample string 38</RC2>
    <RC3>sample string 39</RC3>
    <RC4>sample string 40</RC4>
    <RC5>sample string 41</RC5>
    <RS>46</RS>
    <SchoolCode>1</SchoolCode>
    <StudentId>3</StudentId>
    <StudentNumber>2</StudentNumber>
    <Tag>sample string 11</Tag>
    <TagDescription>sample string 12</TagDescription>
    <U1>sample string 19</U1>
    <U10>sample string 28</U10>
    <U11>sample string 29</U11>
    <U12>sample string 30</U12>
    <U13>sample string 31</U13>
    <U2>sample string 20</U2>
    <U3>sample string 21</U3>
    <U4>sample string 22</U4>
    <U5>sample string 23</U5>
    <U6>sample string 24</U6>
    <U7>sample string 25</U7>
    <U8>sample string 26</U8>
    <U9>sample string 27</U9>
  </Student>
  <Student>
    <BCU>sample string 32</BCU>
    <BCY>sample string 33</BCY>
    <BST>sample string 34</BST>
    <Comment3>sample string 17</Comment3>
    <Contacts>
      <Contact>
        <AN>sample string 24</AN>
        <AP>sample string 21</AP>
        <Address>
          <City>sample string 2</City>
          <State>sample string 3</State>
          <Street1>sample string 1</Street1>
          <Zip>sample string 4</Zip>
        </Address>
        <CL>sample string 22</CL>
        <CellPhone>sample string 12</CellPhone>
        <Code>sample string 17</Code>
        <CodeDescription>sample string 18</CodeDescription>
        <ContactName>sample string 6</ContactName>
        <ED>2024-06-29T00:38:51.8362401-07:00</ED>
        <ELC>sample string 25</ELC>
        <ENM>sample string 20</ENM>
        <Email>sample string 13</Email>
        <FirstName>sample string 7</FirstName>
        <LastName>sample string 9</LastName>
        <LivesWith>sample string 14</LivesWith>
        <MailTag>sample string 19</MailTag>
        <MiddleName>sample string 8</MiddleName>
        <NP>sample string 23</NP>
        <OrderNumber>5</OrderNumber>
        <PhoneNumber>sample string 10</PhoneNumber>
        <RelationCode>sample string 15</RelationCode>
        <RelationDescription>sample string 16</RelationDescription>
        <SchoolCode>1</SchoolCode>
        <SequenceNumber>4</SequenceNumber>
        <StudentId>3</StudentId>
        <StudentNumber>2</StudentNumber>
        <WorkPhone>sample string 11</WorkPhone>
      </Contact>
      <Contact>
        <AN>sample string 24</AN>
        <AP>sample string 21</AP>
        <Address>
          <City>sample string 2</City>
          <State>sample string 3</State>
          <Street1>sample string 1</Street1>
          <Zip>sample string 4</Zip>
        </Address>
        <CL>sample string 22</CL>
        <CellPhone>sample string 12</CellPhone>
        <Code>sample string 17</Code>
        <CodeDescription>sample string 18</CodeDescription>
        <ContactName>sample string 6</ContactName>
        <ED>2024-06-29T00:38:51.8362401-07:00</ED>
        <ELC>sample string 25</ELC>
        <ENM>sample string 20</ENM>
        <Email>sample string 13</Email>
        <FirstName>sample string 7</FirstName>
        <LastName>sample string 9</LastName>
        <LivesWith>sample string 14</LivesWith>
        <MailTag>sample string 19</MailTag>
        <MiddleName>sample string 8</MiddleName>
        <NP>sample string 23</NP>
        <OrderNumber>5</OrderNumber>
        <PhoneNumber>sample string 10</PhoneNumber>
        <RelationCode>sample string 15</RelationCode>
        <RelationDescription>sample string 16</RelationDescription>
        <SchoolCode>1</SchoolCode>
        <SequenceNumber>4</SequenceNumber>
        <StudentId>3</StudentId>
        <StudentNumber>2</StudentNumber>
        <WorkPhone>sample string 11</WorkPhone>
      </Contact>
    </Contacts>
    <CorrespondenceLanguage>sample string 15</CorrespondenceLanguage>
    <DateOfBirth>2024-06-29T00:38:51.8362401-07:00</DateOfBirth>
    <ETH>sample string 35</ETH>
    <EnrollmentHistory>
      <Enrollment>
        <EnterDate>2024-06-29T00:38:51.8362401-07:00</EnterDate>
        <Grade>5</Grade>
        <LeaveDate>2024-06-29T00:38:51.8362401-07:00</LeaveDate>
        <SchoolCode>2</SchoolCode>
        <StudentId>1</StudentId>
        <StudentNumber>3</StudentNumber>
        <Year>4</Year>
      </Enrollment>
      <Enrollment>
        <EnterDate>2024-06-29T00:38:51.8362401-07:00</EnterDate>
        <Grade>5</Grade>
        <LeaveDate>2024-06-29T00:38:51.8362401-07:00</LeaveDate>
        <SchoolCode>2</SchoolCode>
        <StudentId>1</StudentId>
        <StudentNumber>3</StudentNumber>
        <Year>4</Year>
      </Enrollment>
    </EnrollmentHistory>
    <FW>sample string 43</FW>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 9</Gender>
    <Grade>7</Grade>
    <HealthIssues>sample string 18</HealthIssues>
    <HomeLanguage>sample string 16</HomeLanguage>
    <LF>sample string 48</LF>
    <LastName>sample string 5</LastName>
    <MW>sample string 42</MW>
    <MailingAddress>
      <City>sample string 2</City>
      <State>sample string 3</State>
      <Street1>sample string 1</Street1>
      <Zip>sample string 4</Zip>
    </MailingAddress>
    <MiddleName>sample string 6</MiddleName>
    <NRS>47</NRS>
    <NS>45</NS>
    <NextGrade>8</NextGrade>
    <PED>sample string 36</PED>
    <PEM>sample string 44</PEM>
    <ParentGuardian>sample string 13</ParentGuardian>
    <PhysicalAddress>
      <City>sample string 2</City>
      <State>sample string 3</State>
      <Street1>sample string 1</Street1>
      <Zip>sample string 4</Zip>
    </PhysicalAddress>
    <PrimaryPhone>sample string 14</PrimaryPhone>
    <RC1>sample string 37</RC1>
    <RC2>sample string 38</RC2>
    <RC3>sample string 39</RC3>
    <RC4>sample string 40</RC4>
    <RC5>sample string 41</RC5>
    <RS>46</RS>
    <SchoolCode>1</SchoolCode>
    <StudentId>3</StudentId>
    <StudentNumber>2</StudentNumber>
    <Tag>sample string 11</Tag>
    <TagDescription>sample string 12</TagDescription>
    <U1>sample string 19</U1>
    <U10>sample string 28</U10>
    <U11>sample string 29</U11>
    <U12>sample string 30</U12>
    <U13>sample string 31</U13>
    <U2>sample string 20</U2>
    <U3>sample string 21</U3>
    <U4>sample string 22</U4>
    <U5>sample string 23</U5>
    <U6>sample string 24</U6>
    <U7>sample string 25</U7>
    <U8>sample string 26</U8>
    <U9>sample string 27</U9>
  </Student>
</ArrayOfStudent>