LoudVoice API \ Authors \ Get author details
LoudVoice API Resources
| 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 |
Workflow
Request: the code to send to the API
Send an API request to one of these endpoints to retrieve the details of an author:
GET
/loudvoice/authors/<author_token>.json
GET
/loudvoice/authors/author.json?author_reference=<author_reference>
The <author_token> represents the unique identifier of the author.
The <author_reference> is the unique reference that you optionally specified when you created the author.
Result: the code returned by the API
The API will either return a HTTP status code 200 on success or an appropriate message body with
further details on the error that occured.
Example Resultset
{
"response": {
"request": {
"date": "Thu, 22 Mar 2018 14:12:15 0100",
"resource": "/loudvoice/authors/d86196e7-969d-48ad-8fe1-63a1f074f9b0.json",
"status": {
"flag": "success",
"code": 200,
"info": "Your request has been processed successfully"
}
},
"result": {
"data": {
"author": {
"author_token": "d86196e7-969d-48ad-8fe1-63a1f074f9b0",
"identity_token": "5dd7336a-cb66-42dc-95da-1a6dade8f743",
"author_reference": "USER-145",
"name": "Jane Doe",
"email": "jane@example.com",
"picture_url": "http://www.example.com/jane/avatar.png",
"website_url": "http://www.example.com/",
"description": null,
"num_comments": 11,
"date_last_comment": "Mon, 19 Mar 2018 16:54:59 0100",
"date_creation": "Wed, 14 Mar 2018 14:18:30 0100",
"date_last_update": "Wed, 14 Mar 2018 14:18:30 0100"
}
}
}
}
}