lock
GET
api/kiosk/v1/student/{studentIdentifier}
Fetch data on a student
EXPANDexpand_more
Request Information
Roles
- Vendor_Kiosk
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| studentIdentifier |
device's identifier |
string |
Required |
Body Parameters
None.
EXPANDexpand_more
Response Information
Resource Description
204 or 400
FetchStudentResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| identifier | string |
None. |
|
| naturalIdentifer | string |
None. |
|
| firstName | string |
None. |
|
| lastName | string |
None. |
|
| class | string |
None. |
|
| shouldSignIn | boolean |
None. |
|
| authorisedAbsensesForToday | Collection of AuthorisedAbsensesForToday |
None. |
|
| peripateticStatus | PeripateticStatus |
None. |
Response Formats
{
"identifier": "sample string 1",
"naturalIdentifer": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"class": "sample string 5",
"shouldSignIn": true,
"authorisedAbsensesForToday": [
{
"from": "sample string 1",
"to": "sample string 2",
"reason": "sample string 3"
},
{
"from": "sample string 1",
"to": "sample string 2",
"reason": "sample string 3"
}
],
"peripateticStatus": {
"isCheckedIn": true,
"location": "sample string 2"
}
}
<FetchStudentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings.Kiosk">
<authorisedAbsensesForToday>
<AuthorisedAbsensesForToday>
<from>sample string 1</from>
<reason>sample string 3</reason>
<to>sample string 2</to>
</AuthorisedAbsensesForToday>
<AuthorisedAbsensesForToday>
<from>sample string 1</from>
<reason>sample string 3</reason>
<to>sample string 2</to>
</AuthorisedAbsensesForToday>
</authorisedAbsensesForToday>
<class>sample string 5</class>
<firstName>sample string 3</firstName>
<identifier>sample string 1</identifier>
<lastName>sample string 4</lastName>
<naturalIdentifer>sample string 2</naturalIdentifer>
<peripateticStatus>
<isCheckedIn>true</isCheckedIn>
<location>sample string 2</location>
</peripateticStatus>
<shouldSignIn>true</shouldSignIn>
</FetchStudentResponse>