API docs by Redocly

ECS Loans API (v1)

ecsLoans

checkOutByBarcode

Checks item out by barcode

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the item to be lent to the patron

userBarcode
required
string

Barcode of the user (representing the patron) the item is to be lent to

proxyUserBarcode
string

Barcode of the user representing a proxy for the patron

loanDate
string <date-time>

When the loan is to begin, defaults to current date and time

servicePointId
required
string <uuid>

Service point where the item has been checked out

forceLoanPolicyId
string <uuid>

Force loan policy ID

object

Blocks to override

object

'Item not loanable' block

patronBlock
object

Automated patron block

itemLimitBlock
object

Item limit block

renewalBlock
object

Renewal block

object

Override renewal block which requires due date field

comment
string

Reason for override

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string",
  • "userBarcode": "string",
  • "proxyUserBarcode": "string",
  • "loanDate": "2019-08-24T14:15:22Z",
  • "servicePointId": "1e4733b3-067d-44f7-9353-ce708a03d0fc",
  • "forceLoanPolicyId": "3ff1a78c-ba8a-4944-b13b-6d94dca8c27a",
  • "overrideBlocks": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "borrower": {
    },
  • "proxyUserId": "string",
  • "itemId": "string",
  • "loanPolicyId": "string",
  • "loanPolicy": {
    },
  • "overdueFinePolicyId": "string",
  • "overdueFinePolicy": {
    },
  • "lostItemPolicyId": "string",
  • "lostItemPolicy": {
    },
  • "item": {
    },
  • "loanDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "action": "string",
  • "renewalCount": 0,
  • "feesAndFines": {
    },
  • "metadata": { }
}

declareItemLost

Declare item lost

Request Body schema: application/json
required
servicePointId
required
string <uuid>

ID of the service point where item is declared lost

declaredLostDateTime
string <date-time>

Date and time of the item loss

comment
string

Additional information about item loss

loanId
string <uuid>

ID of the loan created for the lost item

itemId
string <uuid>

ID of the lost item

userId
string <uuid>

ID of the user who had lost item on loan

Responses

Request samples

Content type
application/json
{
  • "servicePointId": "1e4733b3-067d-44f7-9353-ce708a03d0fc",
  • "declaredLostDateTime": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 1
}

claimItemReturned

Claim item returned

Request Body schema: application/json
required
itemClaimedReturnedDateTime
required
string <date-time>

The date and time when the item is to be claimed returned

comment
string

Comment explaining why the item has been claimed returned

loanId
string <uuid>

ID of the loan created for the item claimed returned

itemId
string <uuid>

ID of the item claimed returned

userId
string <uuid>

ID of the user who had claimed item returned

Responses

Request samples

Content type
application/json
{
  • "itemClaimedReturnedDateTime": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 1
}