Dataset: Bookmarks

Dataset name: ds_bookmarks

Description

User bookmarks

Fields in this dataset

Name Field Name Description Field Type Field Example
Bookmark Annotation bookmark_annotation Any user annotations against the bookmark text Great stuff.
Browser bookmark_browser The browser this bookmark was captured on. varchar
Bookmark Created bookmark_created The date the bookmark was originally saved date 1343844034
Bookmark Description bookmark_description The description of tthe bookmark text The Space is a digital arts service from Arts Council England and the BBC, bringing great theatre, concerts, opera, dance, film and more to every screen.
Device Name bookmark_device_name The name of the device this bookmark was captured on. varchar
Bookmark Media Duration bookmark_duration If the media type is video, this stores the duration / length text 0.458321759259259
Bookmark Media Height bookmark_height If the media type is image or video, this stores the height of the asset text 400px
Bookmark Media Type bookmark_media_type The media type of the bookmark. One of ‘image’, ‘video’ and ‘page’ currently. text page
Bookmark Modified bookmark_modified The date the bookmark was last updated date 1343844034
Tab bookmark_tab The tab this bookmark was captured on. varchar
Bookmark Tags bookmark_tags The tags associated with the bookmark text arts, media
Bookmark Title bookmark_title The title of the bookmark. Usually grabbed from the page’s title. text The Space
Bookmark URL bookmark_url The url of the bookmark. Could be either a page URL, or a media path e.g. image / video / audio / file text http://thespace.org/
Bookmark Media Width bookmark_width If the media type is image or video, this stores the width of the asset text 800px
Bookmark ID id The primary identifier for this record. number 5
Bookmark Instance instance The instance this transaction relates to. number 8
Bookmark Source source The source of the data - user or connection. text

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_bookmarks
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows. The connection's read/write permissions are listed for each field.

All instances of an accessible dataset are indexed with instance_N notation from N=0.

{
  "ds_bookmarks": {
    "instance_0": {
      "": {
        "value": null,
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_annotation": {
        "value": "Great stuff.",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_browser": {
        "value": null,
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_created": {
        "value": "1343844034",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_description": {
        "value": "The Space is a digital arts service from Arts Council England and the BBC, bringing great theatre, concerts, opera, dance, film and more to every screen.",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_device_name": {
        "value": null,
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_duration": {
        "value": "0.458321759259259",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_height": {
        "value": "400px",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_media_type": {
        "value": "page",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_modified": {
        "value": "1343844034",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_tab": {
        "value": null,
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_tags": {
        "value": "arts, media",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_title": {
        "value": "The Space",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_url": {
        "value": "http://thespace.org/",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "bookmark_width": {
        "value": "800px",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "id": {
        "value": "5",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "instance": {
        "value": "8",
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      },
      "source": {
        "value": null,
        "access": {
          "r": {
            "a": 1,
            "s": "A"
          },
          "w": {
            "a": 1,
            "s": "A"
          }
        }
      }
    }
  }
}