POST api/markings/postMarkingsApp
Methods that inserts markings - bookmarks
Request Information
URI Parameters
None.
Body Parameters
Object of type positiondata that has the marking object that should be inserted
Collection of position| Name | Description | 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": "97d41a6e-292e-44a9-9ead-7446de33cc46",
"groupId": "202c5475-06bc-4897-8f5c-cc237e21ece1",
"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:20:53.9317382-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "97d41a6e-292e-44a9-9ead-7446de33cc46",
"groupId": "202c5475-06bc-4897-8f5c-cc237e21ece1",
"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:20:53.9317382-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
]
application/xml, text/xml
Sample:
<ArrayOfposition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSAeReader.Common.API.Objects">
<position>
<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>202c5475-06bc-4897-8f5c-cc237e21ece1</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>97d41a6e-292e-44a9-9ead-7446de33cc46</syncGuid>
<syncIsRemoved>true</syncIsRemoved>
<textLength>1</textLength>
<timestamp>2025-10-26T16:20:53.9317382-04:00</timestamp>
<type>1</type>
<version>sample string 6</version>
</position>
<position>
<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>202c5475-06bc-4897-8f5c-cc237e21ece1</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>97d41a6e-292e-44a9-9ead-7446de33cc46</syncGuid>
<syncIsRemoved>true</syncIsRemoved>
<textLength>1</textLength>
<timestamp>2025-10-26T16:20:53.9317382-04:00</timestamp>
<type>1</type>
<version>sample string 6</version>
</position>
</ArrayOfposition>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResult[positiondata] with the inserted positiondata object
ApiResultOfListOfposition| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors | ErrorModel |
None. |
|
| Result | Collection of position |
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": [
{
"id": 1,
"syncGuid": "81b98c26-c0a4-4eb0-8ae6-6a80d3246eab",
"groupId": "7ee0f143-1d9c-466b-87df-aec0288586ef",
"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:20:53.9317382-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "81b98c26-c0a4-4eb0-8ae6-6a80d3246eab",
"groupId": "7ee0f143-1d9c-466b-87df-aec0288586ef",
"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:20:53.9317382-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
],
"IsSuccess": false,
"StatusCode": 100
}
application/xml, text/xml
Sample:
<ApiResultOfArrayOfposition8WPzUjNG 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSAeReader.Common.API.Objects">
<d2p1:position>
<d2p1:account_ID>3</d2p1:account_ID>
<d2p1:actionType>1</d2p1:actionType>
<d2p1:bookID>4</d2p1:bookID>
<d2p1:bookName>sample string 5</d2p1:bookName>
<d2p1:chapter>sample string 8</d2p1:chapter>
<d2p1:chapterId>sample string 9</d2p1:chapterId>
<d2p1:color>sample string 14</d2p1:color>
<d2p1:content>sample string 7</d2p1:content>
<d2p1:contentToUpdate>sample string 18</d2p1:contentToUpdate>
<d2p1:endIndex>1</d2p1:endIndex>
<d2p1:groupId>7ee0f143-1d9c-466b-87df-aec0288586ef</d2p1:groupId>
<d2p1:id>1</d2p1:id>
<d2p1:ignoreParentChildRelationship>true</d2p1:ignoreParentChildRelationship>
<d2p1:note>sample string 13</d2p1:note>
<d2p1:section>sample string 10</d2p1:section>
<d2p1:selectionInnerHtml>sample string 16</d2p1:selectionInnerHtml>
<d2p1:selectionOuterHtml>sample string 15</d2p1:selectionOuterHtml>
<d2p1:selectionParentOuterHtml>sample string 20</d2p1:selectionParentOuterHtml>
<d2p1:startIndex>1</d2p1:startIndex>
<d2p1:subSection1>sample string 11</d2p1:subSection1>
<d2p1:subSection2>sample string 12</d2p1:subSection2>
<d2p1:syncGuid>81b98c26-c0a4-4eb0-8ae6-6a80d3246eab</d2p1:syncGuid>
<d2p1:syncIsRemoved>true</d2p1:syncIsRemoved>
<d2p1:textLength>1</d2p1:textLength>
<d2p1:timestamp>2025-10-26T16:20:53.9317382-04:00</d2p1:timestamp>
<d2p1:type>1</d2p1:type>
<d2p1:version>sample string 6</d2p1:version>
</d2p1:position>
<d2p1:position>
<d2p1:account_ID>3</d2p1:account_ID>
<d2p1:actionType>1</d2p1:actionType>
<d2p1:bookID>4</d2p1:bookID>
<d2p1:bookName>sample string 5</d2p1:bookName>
<d2p1:chapter>sample string 8</d2p1:chapter>
<d2p1:chapterId>sample string 9</d2p1:chapterId>
<d2p1:color>sample string 14</d2p1:color>
<d2p1:content>sample string 7</d2p1:content>
<d2p1:contentToUpdate>sample string 18</d2p1:contentToUpdate>
<d2p1:endIndex>1</d2p1:endIndex>
<d2p1:groupId>7ee0f143-1d9c-466b-87df-aec0288586ef</d2p1:groupId>
<d2p1:id>1</d2p1:id>
<d2p1:ignoreParentChildRelationship>true</d2p1:ignoreParentChildRelationship>
<d2p1:note>sample string 13</d2p1:note>
<d2p1:section>sample string 10</d2p1:section>
<d2p1:selectionInnerHtml>sample string 16</d2p1:selectionInnerHtml>
<d2p1:selectionOuterHtml>sample string 15</d2p1:selectionOuterHtml>
<d2p1:selectionParentOuterHtml>sample string 20</d2p1:selectionParentOuterHtml>
<d2p1:startIndex>1</d2p1:startIndex>
<d2p1:subSection1>sample string 11</d2p1:subSection1>
<d2p1:subSection2>sample string 12</d2p1:subSection2>
<d2p1:syncGuid>81b98c26-c0a4-4eb0-8ae6-6a80d3246eab</d2p1:syncGuid>
<d2p1:syncIsRemoved>true</d2p1:syncIsRemoved>
<d2p1:textLength>1</d2p1:textLength>
<d2p1:timestamp>2025-10-26T16:20:53.9317382-04:00</d2p1:timestamp>
<d2p1:type>1</d2p1:type>
<d2p1:version>sample string 6</d2p1:version>
</d2p1:position>
</Result>
<StatusCode>Continue</StatusCode>
</ApiResultOfArrayOfposition8WPzUjNG>