lock
POST
api/kiosk/v1/student/{studentIdentifier}/checkin
allow a student to register arrival
EXPANDexpand_more
Request Information
Roles
- Vendor_Kiosk
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| studentIdentifier |
device's identifier |
string |
Required |
Body Parameters
check in details
StudentCheckInRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| arrivalTimeUTC | string |
None. |
|
| lateArrival | LateArrivalRequest |
None. |
Request Formats
{
"arrivalTimeUTC": "sample string 1",
"lateArrival": {
"identifier": "sample string 1",
"freeText": "sample string 2"
}
}
<StudentCheckInRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings.Kiosk">
<arrivalTimeUTC>sample string 1</arrivalTimeUTC>
<lateArrival>
<freeText>sample string 2</freeText>
<identifier>sample string 1</identifier>
</lateArrival>
</StudentCheckInRequest>
Sample not available.
EXPANDexpand_more
Response Information
Resource Description
204 or 400
CheckInOutResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| redirectToReception | boolean |
None. |
|
| printSlip | boolean |
None. |
|
| additionalSlipDetails | Collection of AdditionalSlipDetail |
None. |
|
| additionalInstructions | string |
None. |
Response Formats
{
"redirectToReception": true,
"printSlip": true,
"additionalSlipDetails": [
{
"label": "sample string 1",
"value": "sample string 2"
},
{
"label": "sample string 1",
"value": "sample string 2"
}
],
"additionalInstructions": "sample string 3"
}
<CheckInOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings.Kiosk">
<additionalInstructions>sample string 3</additionalInstructions>
<additionalSlipDetails>
<AdditionalSlipDetail>
<label>sample string 1</label>
<value>sample string 2</value>
</AdditionalSlipDetail>
<AdditionalSlipDetail>
<label>sample string 1</label>
<value>sample string 2</value>
</AdditionalSlipDetail>
</additionalSlipDetails>
<printSlip>true</printSlip>
<redirectToReception>true</redirectToReception>
</CheckInOutResponse>