This documentation is archived and is not being maintained.

Comment object

Contains info about comments that are associated with a photo, audio, or video on Microsoft OneDrive

Last modified: March 10, 2015

The Live SDK REST API supports reading Comment objects. Use the wl.photos scope to read Comment objects. Use the wl.contacts_photos scope to read the Comment objects that are associated with any albums, photos, and videos that other users have shared with the user.

To get a collection of Comment objects by using the Live SDK REST API, make a GET request to /RESOURCE_ID/comments.

Valid object paths

  • /PHOTO_ID/comments

  • /VIDEO_ID/comments

  • /COMMENT_ID

Structures

The Comment object contains the following structures.

Structure

Type

R/W

Description

data

array

R

An array of Comment objects, if a collection of objects is returned.

id

string

R

The Comment object's id.

from

object

R

Info about the user who created the comment.

name (from object)

string

R

The name of the user who created the comment.

id (from object)

string

R

The ID of the user who created the comment.

message

string

R/W

The text of the comment. The maximum length of a comment is 10,000 characters.

created_time

string

R

The time, in ISO 8601 format, at which the comment was created.

Example

The following is an example of a collection of Comment objects. (For brevity, only the first object is shown.)

JSON
Copy 
{
   "data": [
      {
         "id": "comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979",
         "from": {
            "name": "Roberto Tamburello", 
            "id": "8c8ce076ca27823f"
         }, 
         "message": "A lighthouse built on some rocks.", 
         "created_time": "2011-04-21T23:21:28+0000"
      }, {
         ...
      }
   ]
}
Show: