POST api/synchronization/synchronize
Method used to synchronize the data among the web and desktop applications
Request Information
URI Parameters
None.
Body Parameters
The desktop data that has been modified since the last synchornization timestamp
SynchronizationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Account | account |
None. |
|
| AccountCodes | Collection of AccountCodeDto |
None. |
|
| AccountApplicationId | integer |
None. |
|
| ApplicationType | ApplicationTypes |
None. |
|
| BookHtmlPages | Collection of BookHtmlPage |
None. |
|
| BookStyleSheets | Collection of BookStyleSheet |
None. |
|
| Book | book |
None. |
|
| Markings | Collection of position |
None. |
|
| Books | Collection of book |
None. |
|
| PopupSettings | popupSettings |
None. |
|
| EPubHistoryActivities | Collection of position |
None. |
|
| LastSyncTimestamp | date |
None. |
|
| CurrentSyncTimestamp | date |
None. |
|
| ServerDateTime | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"Account": {
"AccountId": 1,
"Email": "sample string 3",
"Password": "sample string 6",
"LastAccess": "2025-03-13T20:04:43.9577025-04:00",
"FirstName": "sample string 8",
"LastName": "sample string 9",
"FontSize": 1,
"FontColor": "sample string 10",
"BackgroundColor": "sample string 11",
"PageView": 64,
"PasswordHash": "sample string 12",
"SecurityStamp": "sample string 13",
"Timestamp": "2025-03-13T20:04:43.9577025-04:00"
},
"AccountCodes": [
{
"Id": 1,
"AccountId": 2,
"ProductId": 3,
"BookId": 4,
"Date": "2025-03-13T20:04:43.9577025-04:00",
"StartDate": "2025-03-13T20:04:43.9577025-04:00",
"EndDate": "2025-03-13T20:04:43.9577025-04:00"
},
{
"Id": 1,
"AccountId": 2,
"ProductId": 3,
"BookId": 4,
"Date": "2025-03-13T20:04:43.9577025-04:00",
"StartDate": "2025-03-13T20:04:43.9577025-04:00",
"EndDate": "2025-03-13T20:04:43.9577025-04:00"
}
],
"AccountApplicationId": 1,
"ApplicationType": 1,
"BookHtmlPages": [
{
"BookHtmlPageId": 1,
"BookId": 2,
"FileName": "sample string 3",
"HtmlPageTitle": "sample string 4",
"Content": "sample string 5",
"BodyContent": "sample string 6",
"BodyContentForTinyMCE": "sample string 7",
"BodyContentWithoutHtmlTags": "sample string 8",
"RelativePathFromOpfFile": "sample string 9"
},
{
"BookHtmlPageId": 1,
"BookId": 2,
"FileName": "sample string 3",
"HtmlPageTitle": "sample string 4",
"Content": "sample string 5",
"BodyContent": "sample string 6",
"BodyContentForTinyMCE": "sample string 7",
"BodyContentWithoutHtmlTags": "sample string 8",
"RelativePathFromOpfFile": "sample string 9"
}
],
"BookStyleSheets": [
{
"BookStyleSheetId": 1,
"BookId": 2,
"Title": "sample string 3",
"FilePath": "sample string 4",
"OriginalContent": "sample string 5",
"ModifiedContent": "sample string 6"
},
{
"BookStyleSheetId": 1,
"BookId": 2,
"Title": "sample string 3",
"FilePath": "sample string 4",
"OriginalContent": "sample string 5",
"ModifiedContent": "sample string 6"
}
],
"Book": {
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:43.9577025-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:43.9577025-04:00",
"account_code_end_date": "2025-03-13T20:04:43.9577025-04:00",
"datePurchased": "2025-03-13T20:04:43.9577025-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:43.9577025-04:00",
"fileSize": 1
},
"Markings": [
{
"id": 1,
"syncGuid": "538b23c8-1b20-4bd3-a44e-53ae4a8bdc12",
"groupId": "28757ff3-9bbb-40ee-a54b-e83f77c29ccd",
"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:43.9577025-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "538b23c8-1b20-4bd3-a44e-53ae4a8bdc12",
"groupId": "28757ff3-9bbb-40ee-a54b-e83f77c29ccd",
"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:43.9577025-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
],
"Books": [
{
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:43.9577025-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:43.9577025-04:00",
"account_code_end_date": "2025-03-13T20:04:43.9577025-04:00",
"datePurchased": "2025-03-13T20:04:43.9577025-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:43.9577025-04:00",
"fileSize": 1
},
{
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:43.9577025-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:43.9577025-04:00",
"account_code_end_date": "2025-03-13T20:04:43.9577025-04:00",
"datePurchased": "2025-03-13T20:04:43.9577025-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:43.9577025-04:00",
"fileSize": 1
}
],
"PopupSettings": {
"EPubPopupSettingId": 1,
"AccountId": 2,
"Top": 3,
"Left": 4,
"Width": 5,
"Height": 6,
"Timestamp": "2025-03-13T20:04:43.9577025-04:00"
},
"EPubHistoryActivities": [
{
"id": 1,
"syncGuid": "538b23c8-1b20-4bd3-a44e-53ae4a8bdc12",
"groupId": "28757ff3-9bbb-40ee-a54b-e83f77c29ccd",
"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:43.9577025-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "538b23c8-1b20-4bd3-a44e-53ae4a8bdc12",
"groupId": "28757ff3-9bbb-40ee-a54b-e83f77c29ccd",
"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:43.9577025-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
],
"LastSyncTimestamp": "2025-03-13T20:04:43.9577025-04:00",
"CurrentSyncTimestamp": "2025-03-13T20:04:43.9577025-04:00",
"ServerDateTime": "2025-03-13T20:04:43.9577025-04:00"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns ApiResult of object of type SynchronizationModel with books, markings, ePubHistoryActivities and popupSettings properties
ApiResultOfSynchronizationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors | ErrorModel |
None. |
|
| Result | SynchronizationModel |
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": {
"Account": {
"AccountId": 1,
"Email": "sample string 3",
"Password": "sample string 6",
"LastAccess": "2025-03-13T20:04:44.0202044-04:00",
"FirstName": "sample string 8",
"LastName": "sample string 9",
"FontSize": 1,
"FontColor": "sample string 10",
"BackgroundColor": "sample string 11",
"PageView": 64,
"PasswordHash": "sample string 12",
"SecurityStamp": "sample string 13",
"Timestamp": "2025-03-13T20:04:44.0202044-04:00"
},
"AccountCodes": [
{
"Id": 1,
"AccountId": 2,
"ProductId": 3,
"BookId": 4,
"Date": "2025-03-13T20:04:44.0202044-04:00",
"StartDate": "2025-03-13T20:04:44.0202044-04:00",
"EndDate": "2025-03-13T20:04:44.0202044-04:00"
},
{
"Id": 1,
"AccountId": 2,
"ProductId": 3,
"BookId": 4,
"Date": "2025-03-13T20:04:44.0202044-04:00",
"StartDate": "2025-03-13T20:04:44.0202044-04:00",
"EndDate": "2025-03-13T20:04:44.0202044-04:00"
}
],
"AccountApplicationId": 1,
"ApplicationType": 1,
"BookHtmlPages": [
{
"BookHtmlPageId": 1,
"BookId": 2,
"FileName": "sample string 3",
"HtmlPageTitle": "sample string 4",
"Content": "sample string 5",
"BodyContent": "sample string 6",
"BodyContentForTinyMCE": "sample string 7",
"BodyContentWithoutHtmlTags": "sample string 8",
"RelativePathFromOpfFile": "sample string 9"
},
{
"BookHtmlPageId": 1,
"BookId": 2,
"FileName": "sample string 3",
"HtmlPageTitle": "sample string 4",
"Content": "sample string 5",
"BodyContent": "sample string 6",
"BodyContentForTinyMCE": "sample string 7",
"BodyContentWithoutHtmlTags": "sample string 8",
"RelativePathFromOpfFile": "sample string 9"
}
],
"BookStyleSheets": [
{
"BookStyleSheetId": 1,
"BookId": 2,
"Title": "sample string 3",
"FilePath": "sample string 4",
"OriginalContent": "sample string 5",
"ModifiedContent": "sample string 6"
},
{
"BookStyleSheetId": 1,
"BookId": 2,
"Title": "sample string 3",
"FilePath": "sample string 4",
"OriginalContent": "sample string 5",
"ModifiedContent": "sample string 6"
}
],
"Book": {
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:44.0202044-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:44.0202044-04:00",
"account_code_end_date": "2025-03-13T20:04:44.0202044-04:00",
"datePurchased": "2025-03-13T20:04:44.0202044-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:44.0202044-04:00",
"fileSize": 1
},
"Markings": [
{
"id": 1,
"syncGuid": "64a90766-3030-4d8f-b6fd-d4e08b1750bd",
"groupId": "a9c6c713-d94e-4fb6-b5ea-d45d3c18c911",
"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:44.0202044-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "64a90766-3030-4d8f-b6fd-d4e08b1750bd",
"groupId": "a9c6c713-d94e-4fb6-b5ea-d45d3c18c911",
"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:44.0202044-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
],
"Books": [
{
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:44.0202044-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:44.0202044-04:00",
"account_code_end_date": "2025-03-13T20:04:44.0202044-04:00",
"datePurchased": "2025-03-13T20:04:44.0202044-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:44.0202044-04:00",
"fileSize": 1
},
{
"title": "sample string 1",
"url": "sample string 2",
"description": "sample string 3",
"bookIdentifier": "sample string 4",
"cover": "sample string 5",
"locked": true,
"new": true,
"featured": true,
"date": "2025-03-13T20:04:44.0202044-04:00",
"categories": [
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
},
{
"id": 1,
"name": "sample string 2",
"image": "sample string 3",
"image2": "sample string 4",
"color": "sample string 5"
}
],
"ProductId": 10,
"booksBookID": 1,
"version": "sample string 11",
"bookVersion": "sample string 12",
"publisher": "sample string 13",
"author": "sample string 14",
"tableOfContentHTML": "sample string 15",
"tableOfContentEpub30File": "sample string 16",
"contentOpfPath": "sample string 17",
"spineContent": "sample string 18",
"manifestElementContent": "sample string 19",
"parent": "sample string 20",
"isInMyBooks": true,
"account_code_id": 1,
"account_code_start_date": "2025-03-13T20:04:44.0202044-04:00",
"account_code_end_date": "2025-03-13T20:04:44.0202044-04:00",
"datePurchased": "2025-03-13T20:04:44.0202044-04:00",
"lastHistoryActivityDate": "2025-03-13T20:04:44.0202044-04:00",
"fileSize": 1
}
],
"PopupSettings": {
"EPubPopupSettingId": 1,
"AccountId": 2,
"Top": 3,
"Left": 4,
"Width": 5,
"Height": 6,
"Timestamp": "2025-03-13T20:04:44.0202044-04:00"
},
"EPubHistoryActivities": [
{
"id": 1,
"syncGuid": "64a90766-3030-4d8f-b6fd-d4e08b1750bd",
"groupId": "a9c6c713-d94e-4fb6-b5ea-d45d3c18c911",
"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:44.0202044-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
},
{
"id": 1,
"syncGuid": "64a90766-3030-4d8f-b6fd-d4e08b1750bd",
"groupId": "a9c6c713-d94e-4fb6-b5ea-d45d3c18c911",
"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:44.0202044-04:00",
"SyncIsRemoved": true,
"selectionParentOuterHtml": "sample string 20",
"ignoreParentChildRelationship": true
}
],
"LastSyncTimestamp": "2025-03-13T20:04:44.0202044-04:00",
"CurrentSyncTimestamp": "2025-03-13T20:04:44.0202044-04:00",
"ServerDateTime": "2025-03-13T20:04:44.0202044-04:00"
},
"IsSuccess": false,
"StatusCode": 100
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.