Checkin

Start Checkin Process

POST /rpc/.../circulation/checkin

This method allows the caller to check in an item.

Request Information

Parameters
Name Type Required Description
checkinData DtoCheckInData Yes Define this parameter in the request body.
DtoCheckInData
Property Type Nullable Description
CircTranType Int No Required. Sets the type of checkout and applies specific rules.
ItemBarcode String No Barcode of item.
LoginBranchID Int Organization ID where the checkin is occurring. Used for SA settings and to record statistical data.
UserID Int No Required. Staff user ID processing the checkout. Used for SA settings and to record statistical data.
WorkstationID Int No Required. Workstation where the checkout is occurring. Used for SA settings and to record statistical data.
OfflineCheckinDate DateTime Yes Provide a date if this is an offline checkin.
ProcedureStep Int No Set the checkin state machine to the last procedure step.
Answer Int No Value when responding to a prompt.
Request body
application/json, text/json 
{
  "CircTranType": 1,
  "ItemBarcode": "sample string 2",
  "LoginBranchID": 3,
  "UserID": 4,
  "WorkstationID": 5,
  "OfflineCheckinDate": "2013-02-28T16:08:39.8620239-05:00",
  "ProcedureStep": 6,
  "Answer": 7
}

Response Information

Example
application/json, text/json 
{
  "CheckedIn_ItemID": 1,
  "CheckedIn_AssignedBranchID": 2,
  "CheckedIn_AssignedBranchName": "sample string 3",
  "CheckedIn_MaterialTypeID": 4,
  "CheckedIn_MaterialTypeDescription": "sample string 5",
  "CheckedIn_ItemTitle": "sample string 6",
  "PAPIProcedure": 7,
  "PAPIProcedureStep": 8,
  "PAPIAction": 9,
  "PAPIActionProcedure": 10,
  "PAPIPromptType": 11,
  "PAPIStopType": 12,
  "PAPIReturnCode": 13,
  "Success": true,
  "Message": "sample string 15"
}

HTTP Response Codes

Code Description
200 OK. Success