Patron Reading History

Get Patron Reading History Count

GET /api/.../patrons/{id}/readinghistory?countOnly={countOnly}

Return the number of reading history records associated with the patron.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
countOnly Boolean Yes Return the number of reading history records associated with the patron. Value must be set to True.

Response Information

Example
application/json, text/json 
1

HTTP Response Codes

Code Description
200 OK. Success

List Patron Reading History

GET /api/.../patrons/{id}/readinghistory

Returns list of all reading history records associated with the patron.

GET /api/.../patrons/{id}/readinghistory?startIndex={startIndex}&numRecords={numRecords}

Returns a "paginated" list of reading history records associated with the patron.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
startIndex Integer No Position to start record retrieval. When set to -1, return ALL records.
numRecords Integer No Number of records to return. Ignored when startIndex is set to -1.

Listing Response Information

Example List
application/json, text/json 
[
  {
    "ItemRecordID": 1,
    "IsDeleted": true,
    "Title": "sample string 1",
    "BrowseTitleNonFilingCount": 0,
    "Author": "sample string 2",
    "Format": "sample string 3",
    "DateCheckedOut": "2013-03-01T10:15:48.7459162-05:00",
    "LoaningLibrary": "sample string 5",
    "Rating": 1,
    "Notes": "sample string 6",
    "FormatID": 64,
    "BibliographicRecordID": 1,
    "DisplayInPAC": true,
    "TitleRatingID": 1,
    "PatronReadingHistoryID": 8
  },
  {
    "ItemRecordID": 1,
    "IsDeleted": false,
    "Title": "sample string 1",
    "BrowseTitleNonFilingCount": 0,
    "Author": "sample string 2",
    "Format": "sample string 3",
    "DateCheckedOut": "2013-03-01T10:15:48.7459162-05:00",
    "LoaningLibrary": "sample string 5",
    "Rating": 1,
    "Notes": "sample string 6",
    "FormatID": 64,
    "BibliographicRecordID": 1,
    "DisplayInPAC": true,
    "TitleRatingID": 1,
    "PatronReadingHistoryID": 8
  },
  {
    "ItemRecordID": 1,
    "IsDeleted": false,
    "Title": "sample string 1",
    "BrowseTitleNonFilingCount": 0,
    "Author": "sample string 2",
    "Format": "sample string 3",
    "DateCheckedOut": "2013-03-01T10:15:48.7459162-05:00",
    "LoaningLibrary": "sample string 5",
    "Rating": 1,
    "Notes": "sample string 6",
    "FormatID": 64,
    "BibliographicRecordID": 1,
    "DisplayInPAC": true,
    "TitleRatingID": 1,
    "PatronReadingHistoryID": 8
  }
]

HTTP Response Codes

Code Description
200 OK. Success

Delete Patron Reading History Item(s)

DELETE /api/.../patrons/{id}/readinghistory/{historyid},{historyid},{historyid}

Delete one or more patron reading history items.

Required Permissions

Permission IDs found here.

Name
Note
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_RemoveORSPatronReadingHistoryRequired when deleting reading history for an Outreach Services type of patron.
PatronStatus_RemoveNonORSPatronReadingHistoryRequired when deleting reading history for a non-Outreach Services patron.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
historyid Integer Yes One or more (comma separated) reading history IDs to delete

Delete Response Information

If successful, the count of the number of reading history items deleted is returned.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Invalid reading history ID for supplied patron ID or reading history ID not found
404 FAILURE. Invalid patron ID specified
409 CONFLICT. Patron record is secured.