Authors module

This module provides access to manage the list of authors and view their details.

URL Format

You can use GET or POST variables in your requests.

baseUrl/authors.php?action=ACTION&params...

Reference

Some responses may return defined objects inside the JSON that refer to existing classes.

See related:

• Author

Pagination

All requests that return lists can support pagination. Add page=PAGE_NUMBER and limit=[1-1000|default:30] (limit per page) to paginate the responses.

List of actions

The parameter "action" determines the action you would like to match. See below list.

list

List all authors in the system or within a specific department (useful for listing of editors in a grouping such as Our Editors).

Parameters:

• department: (optional) string, filter by department name
• replacedWith: (optional) string, ID of the author that this entry was merged into

Response:

data: [ { Author object } ] 

search

Finds authors with a search query.

Parameters:

• keyword: string, author name search

Response:

data: [ { Author object } ] 

view

Return an author's details.

Parameters:

• authorId: int, ID of the author

Response:

data: [ { Author object } ]