addNote

Method: POST

Resource:

/api/s1m/v2/document/addNote

Request Parameters

Element	Type	Description	Required	Example or Default Value
addNote	Root		Yes
username	String	Profile User Name. This is the user name used by the API, not a ScholarOne Manuscripts user. This is from the Caller’s profile.	Yes	sample_user
password	String	The API Key. Encrypted value uniquely identifying and authenticating Caller	Yes	SRU4DQ5WOJ2PX8CA
site_name	String	Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family.	Yes	web_svcs
url	String	The Web Service URL, which identifies the specific service to handle the request.	Yes	v2/document/addNote
external_id	String	An id value that can be set by the client for call tracking. Caller supplied Text string to be stored with Audit History information.	No	123456
locale_id	Integer	The unique identifier for a specific language. The value of the locale_id must match to the specific language as defined in the Caller’s profile.	No	Options are: 1 (United States English) 2 (Simplified Chinese, Pinyin ordering) 3 (French)
_type	String	The data type requested from the Service <xml> or <json>. This defaults to <xml>.	No	xml (default if omitted), or json

Request Body Elements

The request body must be in JSON format

{
    "input": {
        "documentId": 1001644,
        "noteTitle": "Note title here",
        "noteText": "This is the text of the document note"
    }
}

Body Element Reference

Request Body Element/ Example value	Type	Description	Required
input	Object	Root object containing all the data required for adding a note to the manuscript.	Yes
documentId `1001644`	integer	Unique identifier of the document where the note is being added.	Yes
noteTitle `"Note title here"`	String	Title of the note. Maximum length: 100 characters. Must not contain JavaScript, HTML, or SQL.	Yes
noteText `"This is the text of the document note"`	String	Content of the note. Maximum length: 10,000 characters. Must not contain JavaScript, HTML, or SQL.	No

Error Codes

The following error codes may be returned by the addNote API:

documentId Errors

Error Code	Description
WVLD-11593	documentId is required
WVLD-11594	documentId is too long (40 characters limit)
WVLD-11595	documentId is the wrong type for parameter (Integer required)
WVLD-11596	Bad value range for documentId (allowed range 0–12,147,483,647)
WVLD-11177	Document with documentId not found

noteTitle Errors

Error Code	Description
WVLD-11597	noteTitle is required
WVLD-11598	noteTitle is too long (100 characters limit)
WVLD-11600	Invalid content (e.g., `<script>test</script>` as noteTitle)

noteText Errors

Error Code	Description
WVLD-11599	noteText is too long (10,000 characters limit)
WVLD-11600	Invalid content (e.g., `<script>test</script>` as noteText)