POST

api/kiosk/v1/student/{studentIdentifier}/checkout

allow a student to register departure

Request Information

Roles

Vendor_Kiosk

URI Parameters

Name	Description	Type	Additional information
studentIdentifier	device's identifier	string	Required

Body Parameters

check in details

StudentCheckOutRequest

Name	Type	Additional information
departureTimeUTC	string	None.
earlyDepartureIdentifier	string	None.
earlyDepartureFreeText	string	None.
estimatedReturnTimeUTC	string	None.

Request Formats

{
  "departureTimeUTC": "sample string 1",
  "earlyDepartureIdentifier": "sample string 2",
  "earlyDepartureFreeText": "sample string 3",
  "estimatedReturnTimeUTC": "sample string 4"
}

<StudentCheckOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings.Kiosk">
  <departureTimeUTC>sample string 1</departureTimeUTC>
  <earlyDepartureFreeText>sample string 3</earlyDepartureFreeText>
  <earlyDepartureIdentifier>sample string 2</earlyDepartureIdentifier>
  <estimatedReturnTimeUTC>sample string 4</estimatedReturnTimeUTC>
</StudentCheckOutRequest>

Sample not available.

Response Information

Resource Description

204 or 400

CheckInOutResponse

Name	Type	Additional information
redirectToReception	boolean	None.
printSlip	boolean	None.
additionalSlipDetails	Collection of AdditionalSlipDetail	None.
additionalInstructions	string	None.

{
  "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>