Title Ratings

Title ratings for outreach patrons

List available title ratings for patrons

GET /api/.../ratings

Returns list of patron title ratings

Response Information

The available patron title rating list is returned upon success.

Example
application/json, text/json 
[
    {
        "RatingID":1,
        "Description":"I didn't care for it.  i wouldn't recommend it."
    },
    {
        "RatingID":2,
        "Description":"Fair"
    },
    {
        "RatingID":3,
        "Description":"Good. May recommend it to 1 or 2 friends."
    },
    {
        "RatingID":4,
        "Description":"Very good.  Probably recommend it."
    },
    {
        "RatingID":5,
        "Description":"Liked ti very much. Would definitely recommemd it."
    }
]

Add title rating to a bib

POST /api/.../titleratings

Add title rating to a bib.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
CR_PatronStatus_DisplayReaderServices
CR_PatronStatus_ModifyORSPatronRatings

Request Information

Parameters
Name Type Required Description
dto ExpandoObject Yes Define this parameter in the request body.
dto
Property Type Nullable Description
RatingID Int No
PatronID Int No
PatronReadingHistoryID Int No
BibID Int No
Note String Yes Note
IsORS Boolean No True for outreach patrons
Example
application/json, text/json 
{
    "BibID":283211,
    "IsORS":true,
    "Note":"Adding Rating as 2",
    "RatingID":2,
    "PatronID":"356950",
    "PatronReadingHistoryID":56434
}

Response Information

The newly created TitleRatingID returned upon success.

Example
application/json, text/json 
{
   249531
}

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Invalid PatronID
  • Invalid BibID
404 FAILURE. Invalid PatronID.
409 CONFLICT. Patron record is secured.

Modify Title rating

PUT /api/.../titleratings/{id}

Modify exisiting rating for a title.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
CR_PatronStatus_DisplayReaderServices
CR_PatronStatus_ModifyORSPatronRatings

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to title rating.
dto ExpandoObject Yes Define this parameter in the request body.
dto
Property Type Nullable Description
TitleRatingID Int No
RatingID Int No
PatronReadingHistoryID Int No
Note String No Note
Example
application/json, text/json 
  {   
    "Note":"Adding Rating as 2. rating modified to 5",
    "RatingID":5,"PatronID":"356950",
    "TitleRatingID":2104,    
    "PatronReadingHistoryID":56434
}

Response Information

True is returned upon success.

Example
application/json, text/json 
true

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Invalid PatronID
  • Invalid BibID
404 FAILURE. Invalid PatronID.
409 CONFLICT. Patron record is secured.