Skip to end of banner
Go to start of banner

TLR - settings

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Settings for title-level requests will be stored in mod-configuration (module=SETTINGS, configName=TLR). Value is a JSON-containing string.

JSON schema:

{
"type": "object",
"description": "Title level requests feature settings",
"properties": {
"titleLevelRequestsFeatureEnabled": {
"description": "Allow title level requests",
"type": "boolean"
},
"createTitleLevelRequestsByDefault": {
"description": "'Create title level requests' selected by default",
"type": "boolean"
},
"patronNoticeTemplates": {
"description": "Patron notice templates to use for title level requests",
"type": "object",
"properties": {
"confirmationNotice": {
"description": "Confirmation patron notice ID",
"type": "string"
},
"cancellationNotice": {
"description": "Cancellation patron notice ID",
"type": "string"
},
"expirationNotice": {
"description": "Expiration patron notice ID",
"type": "string"
}
}
}
}
}

Examples of valid JSONs

No settings (equivalent of not having any settings):

{
"titleLevelRequestsFeatureEnabled": false,
"createTitleLevelRequestsByDefault": false,
"patronNoticeTemplates": {
"confirmationNotice": null,
"cancellationNotice": null,
"expirationNotice": null
}
}

TLR feature enabled:

{
"titleLevelRequestsFeatureEnabled": true,
"createTitleLevelRequestsByDefault": false,
"patronNoticeTemplates": {
"confirmationNotice": "e5f5a317-10a3-44e7-a944-0c3ac5a15940",
"cancellationNotice": null,
"expirationNotice": null
}
}
  • No labels