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
/loudvoice/discussions/discussion.json?
|
Read a discussion | – | Update a discussion | Delete a discussion |
Discussion messages
/loudvoice/comments/<discussion_token>/comments.json
/loudvoice/discussions/discussion/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
/loudvoice/authors/author.json?
|
Read an author | – | Update an author | Delete an author |
Resource/URI - Author Sessions | GET | POST | PUT | DELETE |
Author Sessions
/loudvoice/authors/sessions.json
|
– | – | Create/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 |
Workflow
Request: the code to send to the API
Send a GET
request to the resource /loudvoice/authors/<author_token>.json
to retrieve details of an author.
The <author_token>
has to be replaced by the unique token of an existing author.
You can also access the author through it's reference using the following endpoint:
/loudvoice/authors/author.json?author_reference=<author_reference>
.
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", "author_reference": "USER-145", "name": "Jane Doe", "email": "jane@example.com", "description": null, "picture_url": "http://www.example.com/jane/avatar.png", "website_url": "http://www.example.com/", "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" } } } } }