Notes.getList (Method)

Retrieves zero or more notes associated with a page and note. If the UserID argument is 0, CommonSpot returns non-private notes for all users as well as the current user's private notes.

Returns:

GetNotes_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
canDelete Boolean Boolean flag which when set to true indicates that the current user can delete the note.
canMakePublic Boolean Boolean flag which when set to true indicates that the current user can make this note public.
DateLastChanged Datetime The date when the note was last changed.
ElementID ControlID_0 The ID of the element to which the note applies. If this value is 0, the note applies to the object.
isPrivate Boolean Boolean flag which when set to true indicates that the note is private.
Note PlainText_2000 The note.
NoteID NoteID The note's ID.
UserID UserID The ID of the user who created the note.
UserName Person_FirstNameMiddleNameLastName The 'first name middlename lastname' of the note's owner.

Arguments:

Name Type Required Description
objectID PageIDImageIDMultimediaID Required A CommonSpot pageID as saved in sitepages table. If this argument is not set, CommonSpot returns all of a user's note.
elementID ControlID_0_ALL Optional. Defaults to '0'. An element's ID. If this value is 0, CommonSpot returns all of an object's page's notes. If this value is 'ALL', CommonSpot returns all of an object's element and page notes.
userID UserIDSpec Optional. Defaults to '-1'. A user's ID. If this value is 0, CommonSpot retrieves notes from all users. -1 tells CommonSpot to only retrieve notes from the current user, Finally, -2 tells CommonSpot to show all notes except those created by the current user.
noteID NoteID_0 Optional. Defaults to '0'. The note's ID. If this value is 0, CommonSpot returns all notes instead of just one.

Context:

License Requirements None
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization Customization is not supported for this method.

Error Codes:

None

Notes:

None