POST api/markings/editNote

Method to update NOTE record

Request Information

URI Parameters

None.

Body Parameters

The positionData object that represents the NOTE

Name	Type	Additional information
id	integer	None.
syncGuid	globally unique identifier	None.
groupId	globally unique identifier	None.
AccountId	integer	None.
bookID	integer	None.
version	string	None.
content	string	None.
chapter	string	None.
chapterId	string	None.
section	string	None.
subSection1	string	None.
subSection2	string	None.
CharIndexStart	integer	None.
CharIndexEnd	integer	None.
note	string	None.
color	string	None.
type	integer	None.
actionType	integer	None.
textLength	integer	None.
selectionOuterHtml	string	None.
selectionInnerHtml	string	None.
Timestamp	date	None.
SyncIsRemoved	boolean	None.
selectionParentOuterHtml	string	None.
ignoreParentChildRelationship	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "syncGuid": "471df921-9cbd-4657-bf38-cd4f22dcbb6f",
  "groupId": "39efcdeb-c62a-403e-8833-60e204105c31",
  "AccountId": 3,
  "bookID": 4,
  "version": "sample string 6",
  "content": "sample string 7",
  "chapter": "sample string 8",
  "chapterId": "sample string 9",
  "section": "sample string 10",
  "subSection1": "sample string 11",
  "subSection2": "sample string 12",
  "CharIndexStart": 1,
  "CharIndexEnd": 1,
  "note": "sample string 13",
  "color": "sample string 14",
  "type": 1,
  "actionType": 1,
  "textLength": 1,
  "selectionOuterHtml": "sample string 15",
  "selectionInnerHtml": "sample string 16",
  "Timestamp": "2025-10-26T16:21:26.0605445-04:00",
  "SyncIsRemoved": true,
  "selectionParentOuterHtml": "sample string 20",
  "ignoreParentChildRelationship": true
}

application/xml, text/xml

Sample:

<position xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSAeReader.Common.API.Objects">
  <account_ID>3</account_ID>
  <actionType>1</actionType>
  <bookID>4</bookID>
  <bookName>sample string 5</bookName>
  <chapter>sample string 8</chapter>
  <chapterId>sample string 9</chapterId>
  <color>sample string 14</color>
  <content>sample string 7</content>
  <contentToUpdate>sample string 18</contentToUpdate>
  <endIndex>1</endIndex>
  <groupId>39efcdeb-c62a-403e-8833-60e204105c31</groupId>
  <id>1</id>
  <ignoreParentChildRelationship>true</ignoreParentChildRelationship>
  <note>sample string 13</note>
  <section>sample string 10</section>
  <selectionInnerHtml>sample string 16</selectionInnerHtml>
  <selectionOuterHtml>sample string 15</selectionOuterHtml>
  <selectionParentOuterHtml>sample string 20</selectionParentOuterHtml>
  <startIndex>1</startIndex>
  <subSection1>sample string 11</subSection1>
  <subSection2>sample string 12</subSection2>
  <syncGuid>471df921-9cbd-4657-bf38-cd4f22dcbb6f</syncGuid>
  <syncIsRemoved>true</syncIsRemoved>
  <textLength>1</textLength>
  <timestamp>2025-10-26T16:21:26.0605445-04:00</timestamp>
  <type>1</type>
  <version>sample string 6</version>
</position>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult[string] with the result of the delete operation

ApiResultOfString

Name	Type	Additional information
Errors	ErrorModel	None.
Result	string	None.
IsSuccess	boolean	None.
StatusCode	HttpStatusCode	None.

Response Formats

application/json, text/json

Sample:

{
  "Errors": {
    "ErrorsNumber": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "MessagesString": "sample string 2"
  },
  "Result": "sample string 1",
  "IsSuccess": false,
  "StatusCode": 100
}

application/xml, text/xml

Sample:

<ApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSAeReader.Common.API">
  <Errors>
    <ErrorsNumber>1</ErrorsNumber>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <MessagesString>sample string 2</MessagesString>
  </Errors>
  <Result>sample string 1</Result>
  <StatusCode>Continue</StatusCode>
</ApiResultOfstring>