LoudVoice API \ Authors

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion – –
Discussion /loudvoice/discussions/<discussion_token>.json Read a discussion – Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json Read discussion comments – – –
Resource/URI - Authors GET POST PUT DELETE
Authors /loudvoice/authors.json List all authors Create an author – –
Author /loudvoice/authors/<author_token>.json Read an author – Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json List all sessions – Create or update a session –
Author Session /loudvoice/authors/sessions/<session_token>.json – – – Delete a session
Resource/URI - Comments GET POST PUT DELETE
Comments /loudvoice/comments.json List all comments Create a comment – –
Comment /loudvoice/comments/<comment_token>.json Read a comment – Update a comment Delete a comment
Resource/URI - Votes GET POST PUT DELETE
Votes /loudvoice/votes.json List all
votes 		– – –
Vote /loudvoice/votes/comments/<comment_token>/authors/<author_token>.json Read a vote – Cast a vote Delete a vote

An author is a collection of data that describes a person who has left a comment. Each author is uniquely identified by an author_token.

Structure

Author nodes have the format below. Absent values are returned as null. 

{
  "author": {
    "author_token": "#author_token#",
    "author_reference": "#author_reference#",
    "identity_token": "#identity_token#",
    "name": "#name#",
    "email": "#email#",
    "description": "#description#",
    "picture_url": "#picture_url#",
    "website_url": "#website_url#",
    "num_comments": #num_comments#,
    "date_last_comment": "#date_last_comment#",
    "date_creation": "#date_creation#",
    "date_last_update": "#date_last_update#"
  }
}
Node Description
Identifiers
author_token
uuid, automatically generated 		Unique identifier of this author. Generated automatically by the API.
Example: e570f17a-f018-49f2-be95-35dd31105c93
author_reference
string 		Your custom reference for this author, e.g. the unique id of the user in your system. The value must be unique amongst all authors.
Example : USER-123456
Identity
identity_token
string 		The identifier of the identity associated to the author.
Example : 247db8ab-0af5-4a01-8dd1-a9454d76c23e
Metadata
name
string 		The author's name, as displayed in the LoudVoice widget.
Example: John Doe
email
string, email 		The author's email address.
Example: john.doe@example.com
picture_url
string, uri 		The fully qualified URL of the author's avatar.
Example: https://www.example.com/user/avatar.png
website_url
string, uri
 The fully qualified URL of the author's website.
Example: http://www.example.com/
description
string 		Information about the author.
Example: A writer by day and a reader by night
num_comments
integer 		Number of comments posted by the author.
Example: 123
date_last_comment
string, RFC 2822 		Date when the author posted his last comment.
Example: Wed, 14 Mar 2018 14:19:49 +0100
date_creation
string, RFC 2822 		Date when the author was added.
Example: Wed, 14 Mar 2018 14:19:49 +0100
date_last_update
string, RFC 2822 		Date when the author was updated last.
Example: Wed, 14 Mar 2018 14:19:49 +0100

User Contributed Notes