Manage Missing ItemParts

Manage missing parts from check in view

PUT /api/.../itemrecords/{id}?actiontype=specialcheckin

Update item record status with either Claim Missing Parts (21) or Unavailable (16).

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the item record.
dto ExpandoObject Yes Define this parameter in the request body.
actiontype String Yes Define this parameter in the request query string to manage item record. Possible Values: specialcheckin
dto
Property Type Nullable Description
ItemStatusID Int No Possible values are Claim Missing Parts (21) and Unavailable (16)
Note String No Special item check-in note.
IgnoreClaimCount Boolean Yes Define this parameter in the dto to indicate whether or not to continue if patron's overall claim counts exceeds. Possible Values: "True" or "False"
Example
application/json, text/json 
  {
    "Note":"Manage Missing Parts note",
    "IgnoreClaimCount":false,
    "ItemStatusID":21
  }

Response Information

Example - 200 OK
application/json, text/json

Item record has been updated

{
  "PAPIProcedure": 0,
  "PAPIProcedureStep": 0,
  "PAPIAction": 0,
  "PAPIActionProcedure": 0,
  "PAPIPromptType": 0,
  "PAPIStopType": 0,
  "PAPIReturnCode": 0,
  
  "Success": true,
  "Message": ""
}

Patron is secured

{
  "PAPIProcedure": 0,
  "PAPIProcedureStep": 0,
  "PAPIAction": 1,
  "PAPIActionProcedure": 0,
  "PAPIPromptType": 1,
  "PAPIStopType": 1,
  "PAPIReturnCode": -3621,
  "Success": false,
  "Message": "You can't do this because the patron record for the last borrower of this item is secured. You can make the item Unavailable"
}

Patron has exceeded total number of claims allowed

{
  "PAPIProcedure": 0,
  "PAPIProcedureStep": 0,
  "PAPIAction": 2,
  "PAPIActionProcedure": 0,
  "PAPIPromptType": 4,
  "PAPIStopType": 0,
  "PAPIReturnCode": -10504,
  "Success": false,
  "Message": "Patron has exceeded total number of claims allowed. Do you want to continue with this operation. "
}

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Bad request
  • Item ID is invalid
403 FAILURE. Bad request
  • User or workstation is not privileged.
404 FAILURE. Bad request
  • Item not found with ID {0}.
409 FAILURE. Bad request
  • Operation cancelled because Item Record [{0}] is locked.

Required Permissions

Permission IDs found here.

    

        
            

                CR_SpecialItemCheckIn_Access
                
            

            

                CR_SpecialItemCheckIn_SelectUnavailable
                
            

            

                CR_SpecialItemCheckIn_SelectMissingPart 
                
            

            

                CR_OverrideClaimedItemLimits_Allow
                Required if overall claim count exceeds.