Documents

GET api/v2/Organisation/{Slug}/Documents/GetDocument

Description: Returns the lock date for timesheets Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Documents/GetDocument?id=1

Required Parameters:

Id	long value - document id

Response:


{
  "item": {
    "id": 1,
    "organisationId": 10014,
    "name": "synergy-header-logox2",
    "fileNameWithExtension": "synergy-header-logox2.png",
    "folderId": null,
    "folderName": null,
    "folderPath": null,
    "versions": 1,
    "isImage": true,
    "isLocked": false,
    "isCarouselImage": false,
    "blobContainerName": "tomorrow",
    "currentVersionId": 1,
    "currentVersion": "580f3a5f-6f38-4d87-98c4-9c42ecb0473a_V1.png",
    "lastUpdated": null,
    "fileType": ".png",
    "fileSize": 4691,
    "sharedContacts": [],
    "hasBeenViewedByUser": false,
    "hasBeenViewedByOtherUsers": false,
    "emailFromAddress": null,
    "emailToAddress": null,
    "emailSubject": null,
    "emailAttachmentsCount": null,
    "isCheckedOut": false,
    "checkedOutUserName": null,
    "checkedOutUserFullName": null,
    "checkOutDate": null,
    "checkOutDateString": null,
    "checkInDate": "0001-01-01T00:00:00",
    "tags": "Logo-file",
    "hasComments": true,
    "hasAttachments": false,
    "fileSizeString": "4.58 KB"
  },
  "isSuccess": true,
  "message": null
}

Try it out

Organisation

Select

Text

Number

Checkbox

200

        {Response body}

Method

GET

Request Headers

'Content-Type': 'application/json' token

URL

http://some url here.com

GET api/v2/Organisation/{Slug}/Documents/GetRecentDocuments

Description: Returns a list of recently viewed documents Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Documents/GetRecentDocuments Response:


{
  "item": {
    "id": 1,
    "organisationId": 10014,
    "name": "synergy-header-logox2",
    "fileNameWithExtension": "synergy-header-logox2.png",
    "folderId": null,
    "folderName": null,
    "folderPath": null,
    "versions": 1,
    "isImage": true,
    "isLocked": false,
    "isCarouselImage": false,
    "blobContainerName": "tomorrow",
    "currentVersionId": 1,
    "currentVersion": "580f3a5f-6f38-4d87-98c4-9c42ecb0473a_V1.png",
    "lastUpdated": null,
    "fileType": ".png",
    "fileSize": 4691,
    "sharedContacts": [],
    "hasBeenViewedByUser": false,
    "hasBeenViewedByOtherUsers": false,
    "emailFromAddress": null,
    "emailToAddress": null,
    "emailSubject": null,
    "emailAttachmentsCount": null,
    "isCheckedOut": false,
    "checkedOutUserName": null,
    "checkedOutUserFullName": null,
    "checkOutDate": null,
    "checkOutDateString": null,
    "checkInDate": "0001-01-01T00:00:00",
    "tags": "Logo-file",
    "hasComments": true,
    "hasAttachments": false,
    "fileSizeString": "4.58 KB"
  },
  "isSuccess": true,
  "message": null
}