Jump to content

Community

REST API Documentation

/calendar/comments


Create a comment

For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, hidden will only be honoured if the authenticated user has permission to hide content).


Parameters

Name Type Description
Required event int The ID number of the event the comment is for
Required author int The ID number of the member making the comment (0 for guest). Required for requests made using an API Key or the Client Credentials Grant Type. For requests using an OAuth Access Token for a particular member, that member will always be the author
Required content string The comment content as HTML (e.g. "<p>This is a comment.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
author_name string If author is 0, the guest name that should be used
date datetime The date/time that should be used for the comment date. If not provided, will use the current date/time. Ignored for requests using an OAuth Access Token for a particular member
ip_address string The IP address that should be stored for the comment. If not provided, will use the IP address from the API request. Ignored for requests using an OAuth Access Token for a particular member
hidden int 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)

Exceptions

Code Message Description
2L297/3 INVALID_ID The comment ID does not exist
1L297/4 NO_AUTHOR The author ID does not exist
1L297/5 NO_CONTENT No content was supplied
2L297/8 NO_PERMISSION The authorized user does not have permission to comment on that event

Response

Name Type Description
id int ID number
item_id int The ID number of the item this belongs to
author member object Author
date datetime Date
content string The content
hidden bool Is hidden?
url string URL to content

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl tring|null object URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value
×
×
  • Create New...