Communication¶

Thread¶

GET /api/v1/comm/thread/¶

Note

Requires authentication.

Returns the list of threads where the user has posted a note to, has been CC’d or is an author of the addon that the thread is based on.

Request

The standard Listing query params.

For ordering params, see List ordering params.

Parameters:	app (int|string) – id or slug of the app to filter the threads by.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of threads.

GET /api/v1/comm/thread/(int: id)/¶

Note

Does not require authentication if the thread is public.

Response

A thread object, see below for example.

Status Codes:	200 – successfully completed. 403 – not allowed to access this object. 404 – not found.

Example:

{
    "addon": 3,
    "addon_meta": {
        "name": "Test App (kinkajou3969)",
        "slug": "app-3",
        "thumbnail_url": "/media/img/icons/no-preview.png",
        "url": "/app/test-app-kinkajou3969/"
    },
    "created": "2013-06-14T11:54:24",
    "id": 2,
    "modified": "2013-06-24T22:01:37",
    "notes_count": 47,
    "recent_notes": [
        {
            "author": 27,
            "author_meta": {
                "name": "someuser"
            },
            "body": "sometext",
            "created": "2013-06-24T22:01:37",
            "id": 119,
            "note_type": 0,
            "thread": 2
        },
        {
            "author": 27,
            "author_meta": {
                "name": "someuser2"
            },
            "body": "sometext",
            "created": "2013-06-24T21:31:56",
            "id": 118,
            "note_type": 0,
            "thread": 2
        },
        ...
        ...
    ],
    "version": null
}

Notes on the response.

Parameters:	recent_notes (array) – contain 5 recently created notes.

PATCH /api/v1/comm/thread/(int: thread_id)/¶

Note

Requires authentication.

This endpoint can be used to mark all notes in a thread as read.

Request

Parameters:	is_read – set it to true to mark the note as read.

Response

Status Codes:	code – 204 Thread is marked as read. code – 403 There is an attempt to modify other fields or not allowed to access the object. code – 400 Thread object not found.

POST /api/v1/comm/thread/¶

Note

Requires authentication.

Request

Parameters:	addon (int) – the id of the addon. version (int) – the id of the version of the addon.

Response

Param :	A thread.
Status Codes:	code – 201 successfully created.

DELETE /api/v1/comm/thread/(int: id)/¶

Note

Requires authentication.

Response

Status Codes:	code – 204 successfully deleted.

Note¶

GET /api/v1/comm/thread/(int: thread_id)/note/¶

Note

Does not require authentication if the thread is public.

Returns the list of notes that the thread contains.

Request

The standard Listing query params.

For ordering params, see List ordering params.

In addition to above, there is another query param:

Parameters:	show_read (boolean) – Filter notes by read status. Pass true to list read notes and false for unread notes.

Response

Parameters:	meta – Listing response meta. objects – A listing of notes.

GET /api/v1/comm/thread/(int: thread_id)/note/(int: id)/¶

Note

Does not require authentication if the note is in a public thread.

Request

The standard Listing query params.

Response

A thread object, see below for example.

Status Codes:	200 – successfully completed. 403 – not allowed to access this object. 404 – not found.

Example:

{
    "author": 1,
    "author_meta": {
        "name": "Landfill Admin"
    },
    "body": "hi there",
    "created": "2013-06-14T11:54:48",
    "id": 2,
    "note_type": 0,
    "thread": 2,
    "is_read": false
}

Notes on the response.

Parameters:	note_type (int) – type of action taken with the note. is_read (boolean) – Whether the note is read or unread.

Note type values and associated actions -

0 - No Action

1 - Approval

2 - Rejection

3 - Disabled

4 - MoreInfo

5 - Escalation

6 - Reviewer Comment

7 - Resubmission

PATCH /api/v1/comm/thread/(int: thread_id)/note/(int: id)/¶

Note

Requires authentication.

This endpoint can be used to mark an unread note as read.

Request

Parameters:	is_read – set it to true to mark the note as read.

Response

Status Codes:	code – 204 Note marked as read. code – 403 There is an attempt to modify other fields or not allowed to access the object. code – 400 Note object not found.

POST /api/v1/comm/thread/(int: thread_id)/note/¶

Note

Requires authentication.

Request

Parameters:	author (int) – the id of the addon. thread (int) – the id of the thread to post to. note_type (int) – the type of note to create. See supported types. body (string) – the comment text to be attached with the note.

Response

Param :	A note.
Status Codes:	code – 201 successfully created.

DELETE /api/v1/comm/thread/(int: thread_id)/note/(int: id)/¶

Note

Requires authentication.

Response

Status Codes:	code – 204 successfully deleted.