GET api/markings/getMarkingsApp?id={id}&type={type}&chapterId={chapterId}&search={search}

Method that returns the marking by id, the type of the marking and

Request Information

URI Parameters

Name	Type	Additional information
id	integer	Required
type	integer	None.
chapterId	string	None.
search	string	None.

Body Parameters

None.

Response Information

Resource Description

ApiResultOfListOfposition

Name	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": "6a4d6ee1-10ce-4917-afa6-e98062c1dec8",
      "groupId": "e454baef-5b7c-486b-84cc-7fffa5510209",
      "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": "2024-12-15T13:19:02.3400246-05:00",
      "SyncIsRemoved": true,
      "selectionParentOuterHtml": "sample string 20",
      "ignoreParentChildRelationship": true
    },
    {
      "id": 1,
      "syncGuid": "6a4d6ee1-10ce-4917-afa6-e98062c1dec8",
      "groupId": "e454baef-5b7c-486b-84cc-7fffa5510209",
      "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": "2024-12-15T13:19:02.3400246-05: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>e454baef-5b7c-486b-84cc-7fffa5510209</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>6a4d6ee1-10ce-4917-afa6-e98062c1dec8</d2p1:syncGuid>
      <d2p1:syncIsRemoved>true</d2p1:syncIsRemoved>
      <d2p1:textLength>1</d2p1:textLength>
      <d2p1:timestamp>2024-12-15T13:19:02.3400246-05: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>e454baef-5b7c-486b-84cc-7fffa5510209</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>6a4d6ee1-10ce-4917-afa6-e98062c1dec8</d2p1:syncGuid>
      <d2p1:syncIsRemoved>true</d2p1:syncIsRemoved>
      <d2p1:textLength>1</d2p1:textLength>
      <d2p1:timestamp>2024-12-15T13:19:02.3400246-05:00</d2p1:timestamp>
      <d2p1:type>1</d2p1:type>
      <d2p1:version>sample string 6</d2p1:version>
    </d2p1:position>
  </Result>
  <StatusCode>Continue</StatusCode>
</ApiResultOfArrayOfposition8WPzUjNG>