Outreach Patron's Others

Get Others

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

Return a list of all existing outreach patron's target audience, Marc language, material type and publication date lists.

Request Information

Response Information

Example
application/json, text/json 
{
  "PatronID": 357374,
  "TargetAudiences": [
    "e",
    "g",
    " "
  ],
  "ExcludeTargetAudiences": true,
  "Languages": [
    "fre",
    "ita"
  ],
  "ExcludeLanguages": true,
  "MaterialTypes": [
    24,
    1
  ],
  "ExcludeMaterialTypes": true,
  "PublicationDates": [
    "2021",
    "2020",
    "2019",
    "2018"
  ],
  "ExcludePublicationDates": true
}

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Update Others

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

Update outreach patron's target audience, Marc language, material type and publication date lists.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Request Information

Parameters
Name Type Required Description
orsData DtoORSPreferencesOther Yes Define this parameter in the request body.
id Integer Yes The unique id assigned to the patron.
DtoORSPreferencesOther
Property Type Nullable Description
PatronID Int No The unique id assigned to the patron.
TargetAudiences List of strings Yes List of target audiences.
ExcludeTargetAudiences Boolean Yes If true, target audiences that are listed will not be used for search.
Languages List of strings Yes List of marc languages.
ExcludeLanguages Boolean Yes If true, languages that are listed will not be used for search.
MaterialTypes List of strings Yes List of material types.
ExcludeMaterialTypes Boolean Yes If true, materials that are listed will not be used for search.
PublicationDates List of strings Yes List of publication dates.
ExcludePublicationDates Boolean Yes If true, dates that are listed will not be used for search.
Request body
Example
application/json, text/json 
{
  "PatronID": 357374,
  "TargetAudiences": [
    "e",
    "g",
    " "
  ],
  "ExcludeTargetAudiences": true,
  "Languages": [
    "fre",
    "ita"
  ],
  "ExcludeLanguages": true,
  "MaterialTypes": [
    24,
    1
  ],
  "ExcludeMaterialTypes": true,
  "PublicationDates": [
    "2021",
    "2020",
    "2019",
    "2018"
  ],
  "ExcludePublicationDates": true
}

Response Information

Returns updated list of target audiences, marc languages, publication dates nad material types if update is successful.
Example
application/json, text/json 
{
  "PatronID": 357374,
  "TargetAudiences": [
    "e",
    "g",
    " "
  ],
  "ExcludeTargetAudiences": true,
  "Languages": [
    "fre",
    "ita"
  ],
  "ExcludeLanguages": true,
  "MaterialTypes": [
    24,
    1
  ],
  "ExcludeMaterialTypes": true,
  "PublicationDates": [
    "2021",
    "2020",
    "2019",
    "2018"
  ],
  "ExcludePublicationDates": true
}

HTTP Response Codes

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