Artifact

bookmark item (Auth)

post/api/artifacts/bookmark/item/{itemId}

Request

Base URL
https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization

Path parameters

itemIdstring uuid required

Response

idstring uuid

rAppUserIdstring uuid

User Id

rArtifactMasterRecordIdstring uuid nullable

Master Record Id

rArtifactItemRecordIdstring uuid nullable

Item Record Id

dateTimestring date-time

DateTime

rBookmarkType0 | 1 | 2

Bookmark Type

notestring nullable

User Note

Example response

{
  "rAppUser": {
    "rImage": {
      "folderName": "2017-08",
      "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png"
    }
  },
  "rArtifactMasterRecord": {
    "coverImage": {
      "folderName": "2017-08",
      "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png",
      "normalSizeImageStoredFileName": "\r\n            e0d7050a-7e30-4a2f-b181-0daa4a1e1068.jpg\r\n            ",
      "thumbnailImageStoredFileName": "\r\n            fbe9cc8e-12fa-4cb9-8f09-bbf353333383.jpg\r\n            "
    },
    "items": [
      {
        "images": [
          {
            "folderName": "2017-08",
            "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png",
            "normalSizeImageStoredFileName": "\r\n            e0d7050a-7e30-4a2f-b181-0daa4a1e1068.jpg\r\n            ",
            "thumbnailImageStoredFileName": "\r\n            fbe9cc8e-12fa-4cb9-8f09-bbf353333383.jpg\r\n            "
          }
        ]
      }
    ]
  },
  "rArtifactItemRecord": {
    "images": [
      {
        "folderName": "2017-08",
        "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png",
        "normalSizeImageStoredFileName": "\r\n            e0d7050a-7e30-4a2f-b181-0daa4a1e1068.jpg\r\n            ",
        "thumbnailImageStoredFileName": "\r\n            fbe9cc8e-12fa-4cb9-8f09-bbf353333383.jpg\r\n            "
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 43 revisions of this API.