lock
POST
api/kiosk/v1/peripatetic/{studentIdentifier}/checkin
Allow a student to checkin to sick-bay, library, etc The location being checked into can be derived from the device role
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
PeripateticCheckInOutRequestName | Description | Type | Additional information |
---|---|---|---|
arrivalTimeUTC | string |
None. |
|
departureTimeUTC | string |
None. |
|
reasonIdentifier | string |
None. |
|
reasonFreeText | string |
None. |
Request Formats
{ "arrivalTimeUTC": "sample string 1", "departureTimeUTC": "sample string 2", "reasonIdentifier": "sample string 3", "reasonFreeText": "sample string 4" }
<PeripateticCheckInOutRequest 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> <departureTimeUTC>sample string 2</departureTimeUTC> <reasonFreeText>sample string 4</reasonFreeText> <reasonIdentifier>sample string 3</reasonIdentifier> </PeripateticCheckInOutRequest>
Sample not available.
EXPANDexpand_more
Response Information
Resource Description
204 or 400
CheckInOutResponseName | 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>