LoudVoice API \ Author Sessions \ List all sessions
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 a GET
request to the resource /loudvoice/authors/sessions.json
to obtain the list of
active sessions.
The following fields may optionally be used to the filter the resultset.
Field | Supported Operators |
---|---|
author_token | eq |
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. Requests that return multiple entries will be
paginated to 250 items by default.
Example Resultset
{ "response": { "request": { "date": "Mon, 30 Sep 2019 18:02:36 +0200", "resource": "/loudvoice/authors/sessions.json?filters=author_token:eq:ca1963a2-a21a-4191-9bb6-fc2b51a11805", "status": { "flag": "success", "code": 200, "info": "Your request has been processed successfully" } }, "result": { "data": { "authors": { "pagination": { "current_page": 1, "total_pages": 1, "entries_per_page": 150, "total_entries": 1, "order": { "field": "date_creation", "direction": "desc" } }, "count": 1, "entries": [ { "author_session_token": "40ad4197-096d-4fd5-af9f-4d0f04196280", "date_creation": "Wed, 25 Sep 2019 11:35:06 +0200", "date_last_update": "Mon, 30 Sep 2019 18:02:15 +0200", "date_expiration": "Mon, 14 Oct 2019 18:02:15 +0200", "expires_in": 1209600, "author": { "author_token": "ca1963a2-a21a-4191-9bb6-fc2b51a11805", "identity_token": "8b285b6b-12fa-45f3-ba95-10aeebc0d887", "author_reference": "USER-424343", "name": "John", "email": "john@example.com", "picture_url": null, "website_url": null, "description": null, "num_comments": 6, "date_last_comment": "Wed, 25 Sep 2019 15:38:44 +0200", "date_creation": "Wed, 25 Sep 2019 11:35:06 +0200", "date_last_update": "Wed, 25 Sep 2019 15:38:44 +0200" } } ] } } } } }