Declare item lost view

Item details to declare it to be lost

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

Declares an item to be lost

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the item record.
lostDto DtoLostDamagedItemData Yes Define this parameter in the request body.
actiontype string Yes Define this parameter in the request query string to declare an item lost. Possible Values: declarelost
DtoLostDamagedItemData
Property Type Nullable Description
PatronID Int No Required.
ItemRecordID Int Yes
AssignedBranchID Int No Required.
BillingNoticeSent Bool Yes
PatronCodeID Int No
PatronBranchID Int No
LoginBranchID Int No
UserID Int No
WorkstationID Int No
PatronStatClassID Int Yes
AssociatedBibRecordID Int Yes
ReplacementAmount Decimal Yes
ReplacementOutstanding Decimal Yes
ReplCostTxnID Int Yes
ReplCostTxnCodeID Int Yes
ProcessingAmount Decimal Yes
ProcessingOutstanding Decimal Yes
ProcChargeTxnID Int Yes
ProcCostTxnCodeID Int Yes
OverdueAmount Decimal Yes
OverdueOutstanding Decimal Yes
OVDChargeTxnID Int Yes
OVDCostTxnCodeID Int Yes
FreeTextNote String Yes Notes
PaymentMethod Int Yes
ILSStoreTransactionID Int No
SendManualBill Boolean Yes Notify the patron of charges
AddedMsg String Yes Additional message to include with the manual bill
CreditCardPaymentData Object Yes DtoCCPaymentData object. Must be supplied when the charges have been paid by credit card.
DtoCCPaymentData
Property Type Nullable Description
TrackId IntNo
ILSStoreTransactionId IntNo
Guid StringYes
VendorId IntNo
BaseAddress StringYes
CustomerID StringYes
TerminalID StringYes
UserName StringYes
Password StringYes
Amount DecimalYes
ProcessingFee DecimalYes
PatronID IntYes
Language IntYes
Result IntNo
TrackNumber StringYes
Error StringYes
TxnStatus StringYes
TroutId StringYes
CCDigits StringYes
CCType StringYes
AuthCode StringYes
Request StringYes
Response StringYes
PaymentsServiceUrl StringYes
Example
application/json, text/json 
{
    "PatronID":358255,
    "PatronBranchID":3,
    "PatronCodeID":1,
    "ItemRecordID":1753575,
    "LoginBranchID":"3",
    "UserID":"1",
    "WorkstationID":"1182",
    "AssignedBranchID":5,
    "AssociatedBibRecordID":null,
    "ReplCostTxnID":null,
    "ProcChargeTxnID":null,
    "OVDChargeTxnID":null,
    "PaymentMethod":11,
    "ReplacementAmount":11.95,
    "ProcessingAmount":0,
    "OverdueAmount":0,
    "ProcessingWaived":0,
    "ReplacementWaived":0,
    "OverdueWaived":0,
    "ReplacementOutstanding":11.95,
    "ProcessingOutstanding":0,
    "OverdueOutstanding":0,
    "ReplCostTxnCodeID":6,
    "ProcCostTxnCodeID":-2,
    "OVDCostTxnCodeID":-2,
    "ILSStoreTransactionID": 0,
    "DtoCCPaymentData": null
}

Response Information

Example

'true' on successful update.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Item not checked out to the patron
404 FAILURE.
  • Patron not found
  • Item not found
409 CONFLICT. Patron record is secured.