API Docs

NAVIGATE CONTENT
Ex Libris Developer Network Alma Documentation REST APIs API Docs

Rest Letter

Overview

For letters and XSL templates.

Data Dictionary

Click here to download rest_letter.xsd

letter

Description: Letter Object.

FieldTypeDescription
codestringThe letter unique code. Mandatory.
enabledstring with attr. Whether to enable the letter.
Possible code are listed in BooleanYesNoNumericCode code table.

The valid values for this parameter are controlled by the code-table: BooleanYesNo. These are the currently defined values for your institution:
CodeDescription
namestringThe letter name. Mandatory.
descriptionstringThe letter description.
channelstringLetter channel
Possible values are listed in 'LetterChannelFilter' code table.

The valid values for this parameter are controlled by the code-table: EMAIL. These are the currently defined values for your institution:
CodeDescription
retention_periodstringThe days to retain the letter.
customizedstring with attr. Whether letter may be customized.
Possible code are listed in BooleanYesNoNumericCode code table.

The valid values for this parameter are controlled by the code-table: BooleanYesNo. These are the currently defined values for your institution:
CodeDescription
patron_facingstring with attr. Letter is viewable by patrons.
Possible code are listed in BooleanYesNoNumericCode code table.

The valid values for this parameter are controlled by the code-table: BooleanYesNo. These are the currently defined values for your institution:
CodeDescription
updated_bystring with attr.
The ID of the user who updated.
update_datedateThe last update date.
labelsstring with attr. Link to the code table.
xslxslThe XSL itself (XML escaped).

 

Samples

XML
JSON
__