API Docs

Rest Notes

Overview

Information about a list of Notes in Alma.

Data Dictionary

Click here to download rest_notes.xsd

notes

Description: List of related notes. In the PUT action the incoming list will replace the existing list.
If the incoming list is empty, the existing list will be deleted.

FieldTypeDescription
notenoteSpecific related note.

 

note

Description: Specific related note.

FieldTypeDescription
contentstringThe note's text. Mandatory.
creation_datedate
The creation date of the note. Default is the current date.
created_bystringThe creator of the note.
typestringRelevant for Citation notes only. The type of the note - Instructor/Library

 

Samples

XML
JSON
__