API Docs
Rest Letter
Overview
For letters and XSL templates.
Data Dictionary
Click here to download rest_letter.xsd
letter
Description: Letter Object.
Field | Type | Description | ||
---|---|---|---|---|
code | string | The letter unique code. Mandatory. | ||
enabled | string with attr. | Whether to enable the letter. Possible code are listed in BooleanYesNoNumericCode code table.
| ||
name | string | The letter name. Mandatory. | ||
description | string | The letter description. | ||
channel | string | Letter channel Possible values are listed in 'LetterChannelFilter' code table.
| ||
retention_ | string | The days to retain the letter. | ||
customized | string with attr. | Whether letter may be customized. Possible code are listed in BooleanYesNoNumericCode code table.
| ||
patron_ | string with attr. | Letter is viewable by patrons. Possible code are listed in BooleanYesNoNumericCode code table.
| ||
updated_ | string with attr. | The ID of the user who updated. | ||
update_ | date | The last update date. | ||
labels | string with attr. | Link to the code table. | ||
xsl | xsl | The XSL itself (XML escaped). |
Samples
XML
JSON
__