LoudVoice API \ Discussions \ List all discussions

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?
discussion_reference=<discussion_reference>
Read a discussion Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json /loudvoice/discussions/discussion/comments.json?
discussion_reference=<discussion_reference>
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?
author_reference=<author_reference>
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/discussions.json to obtain the list of your discussions. The following fields may optionally be used to the filter the resultset.

Field Supported Operators
discussion_reference ct, nct, bw, nbw, ew, new
title ct, nct, bw, nbw, ew, new
url ct, nct, bw, nbw, ew, new
is_closed eq, neq
is_trashed eq, neq

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, 19 Mar 2018 14:49:22 +0100",
            "resource": "/loudvoice/discussions.json",
            "status": {
                "flag": "success",
                "code": 200,
                "info": "Your request has been processed successfully"
            }
        },
        "result": {
            "data": {
                "discussions": {
                    "pagination": {
                        "current_page": 1,
                        "total_pages": 1,
                        "entries_per_page": 250,
                        "total_entries": 2,
                        "order": {
                            "field": "date_creation",
                            "direction": "asc"
                        }
                    },
                    "count": 2
                    "entries": [
                        {
                            "discussion_token": "74306343-9b4c-42cd-978c-f0181b6e9589",
                            "discussion_reference": "PAGE-123",   
                            "title": "Loudvoice Documentation",
                            "url": "http://docs.oneall.com/api/resources/loudvoice/discussion/list/",
                            "is_closed": false,
                            "is_trashed": false,
                            "num_comments": 2,
                            "date_last_comment": "Wed, 14 Mar 2018 14:19:31 +0100",
                            "date_creation": "Wed, 14 Mar 2018 14:18:30 +0100",
                            "date_last_update": "Wed, 12 Mar 2018 11:12:31 +0100"
                        },
                        {
                            "discussion_token": "7da3805b-1c37-463e-a53f-b7f6edc3ef2f",
                            "discussion_reference": "PAGE-124",
                            "title": "Loudvoice API",
                            "url": "http://docs.oneall.com/api/resources/loudvoice/",
                            "is_closed": false,
                            "is_trashed": false,
                            "num_comments": 4,
                            "date_last_comment": "Wed, 14 Mar 2018 14:20:05 +0100",
                            "date_creation": "Wed, 14 Mar 2018 14:19:48 +0100",
                            "date_last_update": null
                        }
                    ]
                }
            }
        }
    }
}
    

User Contributed Notes