GET api/markings/getMarkingById?syncGuid={syncGuid}

Method that returns the marking as positiondata object for a specific syncGuid

Request Information

URI Parameters

NameDescriptionTypeAdditional information
syncGuid

The syncGuid of the marking that should be returned

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ApiResult[positiondata] with the populated markings object

ApiResultOfposition
NameDescriptionTypeAdditional information
Errors

ErrorModel

None.
Result

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": "68a9b0ba-ca88-4231-b2da-dc74262c371e",
    "groupId": "22b3930c-d9a5-45ce-82d0-dfccfb869c63",
    "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-03-13T20:04:41.6461333-04:00",
    "SyncIsRemoved": true,
    "selectionParentOuterHtml": "sample string 20",
    "ignoreParentChildRelationship": true
  },
  "IsSuccess": false,
  "StatusCode": 100
}

application/xml, text/xml

Sample: 
<ApiResultOfposition8WPzUjNG 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: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>22b3930c-d9a5-45ce-82d0-dfccfb869c63</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>68a9b0ba-ca88-4231-b2da-dc74262c371e</d2p1:syncGuid>
    <d2p1:syncIsRemoved>true</d2p1:syncIsRemoved>
    <d2p1:textLength>1</d2p1:textLength>
    <d2p1:timestamp>2025-03-13T20:04:41.6461333-04:00</d2p1:timestamp>
    <d2p1:type>1</d2p1:type>
    <d2p1:version>sample string 6</d2p1:version>
  </Result>
  <StatusCode>Continue</StatusCode>
</ApiResultOfposition8WPzUjNG>