Outreach Patron's Genre

Get Genres

GET /api/.../patrons/{id}/readerservices/preferences/genre

Return a list of all existing outreach patron's genres.

Request Information

Response Information

Example
application/json, text/json 
{
  "PatronID": 357374,
  "IncludeTerms": [
    "Some Genre",
    "Fiction"
  ],
  "ExcludeTerms": [
    "Biographies"
  ]
}

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Update Genres

PUT /api/.../patrons/{id}/readerservices/preferences/genre

Update outreach patron's genre list.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Request Information

Parameters
Name Type Required Description
orsData DtoORSPatronTerms Yes Define this parameter in the request body.
id Integer Yes The unique id assigned to the patron.
DtoORSPatronTerms
Property Type Nullable Description
PatronID Int No The unique id assigned to the patron.
IncludeTerms List of strings Yes List of genres that are included for search.
ExcludeTerms List of strings Yes List of genres that are excluded for search.
Request body
Example
application/json, text/json 
{
  "PatronID": 357374,
  "IncludeTerms": [
    "Some Genre",
    "Fiction"
  ],
  "ExcludeTerms": [
    "Biographies"
  ]
}

Response Information

Returns updated list of genres if update is successful.
Example
application/json, text/json 
{
  "PatronID": 357374,
  "IncludeTerms": [
    "Some Genre",
    "Fiction"
  ],
  "ExcludeTerms": [
    "Biographies"
  ]
}

HTTP Response Codes

Code Description
200 OK. Success
400 Null object. Bad request
409 CONFLICT. Patron record is secured.